Skip to content

Commit 6a683a0

Browse files
authored
Merge pull request #217 from Skivling/mainmenu
add Main Menu & Timelines page
2 parents c2c5f26 + 66fdb37 commit 6a683a0

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
---
2+
Title: Main Menu & Timelines
3+
Date: 2025-09-06
4+
Order: 1
5+
---
6+
7+
## Your Books view
8+
9+
In the top-left of the page (or top of the page on mobile) you will find a small selection of your books.
10+
It will include up to 5 books, from your Currently Reading, Read and To Read reading status shelves.
11+
12+
To see all of them, you may need to *horizontally* scroll, or pull on the horizontal scroll bar.
13+
14+
If you have 3 or 4 currently reading, the To Read section will not be displayed.
15+
Similarly, if all 5 are currently reading, the Read section won't be available either.
16+
However, if you have more than 5 currently reading, it will still only show 5 of them.
17+
18+
By clicking on one of these books, it becomes the focus of the interact and review section.
19+
20+
### Interact & Review section
21+
22+
Below the display of your books is a section that displays basic information about the selected book, and lets you interact with it.
23+
It includes:
24+
25+
- The book's title, linking to its main page.
26+
- The name of the author, linking to the author's page.
27+
- The [update reading status](/shelves.html#updating-reading-status) button for that book.
28+
- Tabs to select a type of status you might want to [post about the book](/posting-statuses.html). The options are Review, Comment or Quote.
29+
- An input form for the selected type of status.
30+
31+
On mobile, you can temporarily hide this section by pressing the X in the top-right corner of it.
32+
33+
## Reading Goal
34+
35+
If you scroll down below the Your Books and post form, you will see your progress towards your reading goal this year.
36+
37+
As a new user you will see a prompt to set your reading goal when you start using BookWyrm.
38+
Otherwise, you can set it by navigating to **Your Profile > Reading Goal**.
39+
Once set, that is also where you can see your progress and all the books you've read this year.
40+
41+
Try setting a goal that is achievable, and will motivate you to read often.
42+
43+
44+
## Search & Barcode Reader
45+
46+
On the top of the home page is a search box, which lets you search for books, authors, users or [lists](/lists.html).
47+
48+
Beside it is a barcode reader which lets you easily find a book by scanning its ISBN barcode using the device camera.
49+
This is especially useful if you're in a bookstore or the library!
50+
51+
## Timelines
52+
53+
Timelines are filled with **statuses** from people you **follow** on Bookwyrm.
54+
It's how you keep up with what your friends are reading, reviewing and recommending.
55+
They take up 2/3 of the screen, or on mobile are found below the reading goal section.
56+
57+
### Following other users
58+
59+
As a new user, you will be suggested some accounts to follow.
60+
You can also search for your friend's username to find and follow them.
61+
If they are using a different BookWyrm website than you (for example, `bookwyrm.social` and `ramblingreaders.org`)
62+
then you can still follow them - but you will need to use their full account name including the instance domain name, like this:
63+
64+
`user@example.com` or `arthur@ramblingreaders.org`
65+
66+
### Home Timeline
67+
68+
Your Home Timeline is a chronological feed of all the statuses about books posted by people you follow.
69+
This includes their reading status updates (want to read, started reading, finished, etc), reviews, ratings, comments, and quotes that they've shared.
70+
Read more about [types of statuses here](/posting-statuses.html).
71+
72+
Your Home Timeline also includes any statuses that people you follow have **boosted**.
73+
This is similar to reposting or reblogging on other platforms, and means that status has been shared into your Timeline.
74+
Boosting is the best way to share good reviews with your followers, and helps them find interesting people to follow.
75+
This is especially useful since there is no algorithm deciding what to show you,
76+
only the real humans that you've decided to follow.
77+
78+
If you follow people on other fediverse apps, such as Mastodon, you will not find their normal text posts in your timeline.
79+
However, posts they boost or their replies to other posts will be included in it.
80+
81+
### Books Timeline
82+
83+
Your Books Timeline is a chronological feed that collects statuses posted about books that you have in [your shelves](/shelves.html).
84+
85+
It might not display *all* statuses, if your BookWyrm website doesn't know about some
86+
87+
### Interacting with statuses
88+
89+
You can reply to any status in your timeline to start a discussion, and boost or like the status.
90+
Under 'More Options' there is a link to send a direct message to the poster, report the status, or block them.
91+
92+
### Filtering Timelines
93+
94+
Both timelines have a Filters menu which lets you filter what types of statuses you'd like to see in it.
95+
You can include or exclude Reviews, Comments, Quotations, or Everything Else (including reading status updates).
96+
Then click the 'Apply filters' button to reload the timeline with the new filters.
97+
98+
A little badge called 'Filters are applied' will be shown after filters are changed,
99+
but this disappears after another page reload even though filters are still in effect.
100+
101+
## Navigation to other pages
102+
103+
There are many links within the main menu to navigate to other pages on BookWyrm.
104+
105+
### Top menu bar
106+
107+
In the top bar is the search box to go to the search page, and links to [Lists](/lists.html), Discover (recent statuses from the local instance), and [Your Books](/shelves.html).
108+
109+
On the right hand side is your profile icon and name.
110+
When clicked, it has links to your Profile, the Directory of other users, your Direct Messages, Settings, and the Log Out button.
111+
112+
On the far right is the Notifications button.
113+
It will display a number if you have unread notifications.
114+
115+
On mobile, some of these options will be collapsed into a 3 dots option which will show them.
116+
117+
### Footer
118+
119+
The website footer also includes links related to the administration of the site, link to this documentation and to re-start the Guided Tour.
120+
121+
If you are using a free BookWyrm instance, there might be a link to financially support the admins in the footer.
122+
Public instances require many hours of management and up to several hundred dollars a year to run.
123+
If you like using your BookWyrm site, please consider supporting them to keep it online and running smoothly!
124+

0 commit comments

Comments
 (0)