]> BookStack Code Mirror - website/commitdiff
Added getting around images, finished page
authorDan Brown <redacted>
Mon, 12 Dec 2022 19:52:43 +0000 (19:52 +0000)
committerDan Brown <redacted>
Mon, 12 Dec 2022 19:52:43 +0000 (19:52 +0000)
content/docs/user/getting-around.md
static/images/docs/user/getting_around_book_navigation.png [new file with mode: 0644]
static/images/docs/user/getting_around_breadcrumb_dropdown.png [new file with mode: 0644]
static/images/docs/user/getting_around_breadcrumb_nav.png [new file with mode: 0644]
static/images/docs/user/getting_around_favourites.png [new file with mode: 0644]
static/images/docs/user/getting_around_next_prev_links.png [new file with mode: 0644]
static/images/docs/user/getting_around_recent_activity.png [new file with mode: 0644]
static/images/docs/user/getting_around_recently_updated.png [new file with mode: 0644]
static/images/docs/user/getting_around_search_preview.png [new file with mode: 0644]
themes/bookstack/layouts/partials/menu_user_docs.html

index 7336856306a89a3564dd003a61daf6396638d38b..d743c41a02ea32c979e4809212db1a0a1cd1acde 100644 (file)
@@ -1,57 +1,59 @@
 +++
-title = "Getting Around & Finding Content"
+title = "Getting Around and Finding Content"
 date = "2022-12-12"
 type = "user-doc"
 slug = "getting-around"
 +++
 
-There's many ways to get around and find content within your BookStack instance
-outside of following the core heirachy. The below details some of the main methods:
+There are many ways to get around and find content within your BookStack instance
+outside of following the core hierarchy. Below is an overview of some common options.
+
+{{<toc>}}
 
 ### Book Sidebar
 
-The book sidebar is visible when within a book, and it reflects the full ordered heirachy 
+The book sidebar is visible when within a book, and it reflects the full ordered hierarchy 
 of the book you are within. If you are within a chapter, that chapter will be expanded by
-default otherwise they will be collapsed & expandable with a click.
+default otherwise they will be collapsed, and expandable with a click.
 
-![View of the book sidebar showing child chapters and pages]()
+![View of the book sidebar showing child chapters and pages](/images/docs/user/getting_around_book_navigation.png)
 
 ### Next & Previous Links
 
-When viewing a page or chapter, you'll find links below that content that allow you to
+When viewing a page or chapter, you'll find links below the main content that allow you to
 navigate between the next & previous content within the current book.
-These links will reflect sibling content, or the next item within the parent level is no next/previous sibling exists.
+These links will reflect sibling content, or the next item within the parent level if no adjacent content exists.
 
-![View of the next & previous actions when viewing a page]()
+![View of the next & previous actions when viewing a page](/images/docs/user/getting_around_next_prev_links.png)
 
 ### Breadcrumbs
 
 As you dive into your BookStack content you'll see breadcrumbs above 
 the main content area to reflect the parent path of the current item.
 These will begin with the "Books" page unless
-you've travelled through the "Shelves" view in which case this would begin with
+you've traveled through the "Shelves" view in which case this would begin with
 the "Shelves" view and parent shelf. 
 
-![View of BookStack items, in a heirachy, with arrows in between]()
+![View of BookStack items, in a hierarchy, with arrows in between](/images/docs/user/getting_around_breadcrumb_nav.png)
 
-You can click on items to jump directly to those. You can also click the 
-arrows between items to search and jump to orthagonal content within 
-the structure heirachy.
+You can click on breadcrumb items to navigate directly to those. You can also click the 
+arrows between items to search and jump to orthogonal content within 
+the structure hierarchy.
 
-![Breadcrumb view with an arrow clicked, showing a popover element listing BookStack pages and chapters]()
+![Breadcrumb view with an arrow clicked, showing a popover element listing BookStack pages and chapters](/images/docs/user/getting_around_breadcrumb_dropdown.png)
 
 ### Search
 
 A major way to find and jump to content is by using search.
 There's the global search input in the header, where you can search across all content in your instance:
 
-![View of the header search bar with a search started and relevant items listed]()
+![View of the header search bar with a search started and relevant items listed](/images/docs/user/getting_around_search_preview.png)
 
 When you start a global search, you'll get live feedback showing a preview of search results.
 You can press enter or "View All" to view all relevant results on the search page.
-On book and chapter views, you'll also find search inputs allowing you to search just within that book or chapter.
+Within the book and chapter views, you'll also find search inputs allowing you to search just within that book or chapter.
 
-Find more information on our [Searching Content](/docs/user/searching/) page.
+Find more information on our ["Searching Content"](/docs/user/searching/) page.
 
 ### Activity Lists
 
@@ -60,22 +62,22 @@ Many views, like that for a book or on the homepage, will show a list of
 current context.
 On these, you can click the name of the item within the listed activity to jump to that item.
 
-![A list of user activity showing linked items names]()
+![A list of user activity showing linked items names](/images/docs/user/getting_around_recent_activity.png)
 
 ### Recently Updated List
 
-On the homepage you can find a "Recently Updated" list, showing the lasted pages
+On the homepage you can find a "Recently Updated" list, showing the latest pages
 to have been created or updated.
 You can press "View All" to view a larger paginated list.
 
-![A card section with title "Recently Updates Pages" with a list of pages below]()
+![A card section with title "Recently Updates Pages" with a list of pages below](/images/docs/user/getting_around_recently_updated.png)
 
 ### Favourites
 
 One way to easily recall content is by adding it to your favourites.
 You can choose to favourite any shelf, book, chapter or page to add it 
 to your personal favourite collection. 
-You can then easily find your favourites, either as a list on the homepage
+You can then easily find your favourites either as a list on the homepage
 or via the "My Favourites" link in the header profile dropdown.
 
-![A view of the "My Favourites" page, with the header profile dropdown menu showing containing a link to "My Favourites"]()
\ No newline at end of file
+![A view of the "My Favourites" page, with the header profile dropdown menu showing containing a link to "My Favourites"](/images/docs/user/getting_around_favourites.png)
\ No newline at end of file
diff --git a/static/images/docs/user/getting_around_book_navigation.png b/static/images/docs/user/getting_around_book_navigation.png
new file mode 100644 (file)
index 0000000..5ac936b
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b50d2fe6fdecb5ce361c8603adf0e205e58ece89b2c2388f7f369ab0cd0ca152
+size 23319
diff --git a/static/images/docs/user/getting_around_breadcrumb_dropdown.png b/static/images/docs/user/getting_around_breadcrumb_dropdown.png
new file mode 100644 (file)
index 0000000..e5f6def
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9fafd5df95fedcb2b072a7be151e28adf33b04914dbab68289335d7dd9ad44b4
+size 90158
diff --git a/static/images/docs/user/getting_around_breadcrumb_nav.png b/static/images/docs/user/getting_around_breadcrumb_nav.png
new file mode 100644 (file)
index 0000000..448d8af
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3fd99e7f8171b70acb8e3ce6c1fff40d3edec5ab8866fa02579e459b9331c2d0
+size 32071
diff --git a/static/images/docs/user/getting_around_favourites.png b/static/images/docs/user/getting_around_favourites.png
new file mode 100644 (file)
index 0000000..8a1ce21
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7d9a9bf4b01e58e544daf9e162c06c578f7acd27e455d1a8a301fd0bee13800b
+size 78793
diff --git a/static/images/docs/user/getting_around_next_prev_links.png b/static/images/docs/user/getting_around_next_prev_links.png
new file mode 100644 (file)
index 0000000..d1800c8
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:084dc66417895f2acfc3fbc3c4e0469618c6eeca52a570dcbd2f68392dcc008a
+size 17486
diff --git a/static/images/docs/user/getting_around_recent_activity.png b/static/images/docs/user/getting_around_recent_activity.png
new file mode 100644 (file)
index 0000000..d1a25a7
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8dc5ff3e0a26b73d337ff92bfa7353ae20df138c7fa199a8afddda9f076d7780
+size 38770
diff --git a/static/images/docs/user/getting_around_recently_updated.png b/static/images/docs/user/getting_around_recently_updated.png
new file mode 100644 (file)
index 0000000..4ca7925
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:edff29bba1c25945b2efa1fbf1b930885d0d48b38c8d85f6db1192fe75b82bf7
+size 43295
diff --git a/static/images/docs/user/getting_around_search_preview.png b/static/images/docs/user/getting_around_search_preview.png
new file mode 100644 (file)
index 0000000..7038177
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3dd94b1e4af222727d52bcd0dc68505b5c323d8e8294fc849ab9cc3bb988a7ae
+size 24784
index 61e01ec10edbb56a3f1ad44b8dfebf4478b8c450..fc7826f6540017514bb8c124138cab60f67966a9 100644 (file)
@@ -3,6 +3,7 @@
        <ul>
                <li><a href="/docs/user/content-overview">Content Overview</a></li>
                <li><a href="/docs/user/organising-content">Organising Content</a></li>
+               <li><a href="/docs/user/getting-around">Getting Around</a></li>
        </ul>
 </div>