Merge pull request #235 from hughrun/v0.7.5

update versions & "using" pages

Author: hughrun

content/using_bookwyrm/adding-books.md

@@ -1,7 +1,7 @@
 ---
 Title: Adding Books
 Date: 2022-07-29
-Order: 2
+Order: 3
 ---
 
 There are a few different ways to add books to your BookWyrm instance! When you can't find the book you're looking for, try these options in order -- it's better to import a book than to create one from scratch.
@@ -15,6 +15,7 @@ If you're coming to BookWyrm from another platform for tracking books and readin
 * LibraryThing (TSV)
 * OpenLibrary (CSV)
 * Storygraph (CSV)
+* OpenReads (CSV)
 
 Under 'Settings' navigate to 'Import Book List', select the matching data source, select your file and, if relevant, select whether to import reviews and what privacy setting to give them. When you press 'Import' a background task will begin to import your data. You will be notified when it has finished.
 

content/using_bookwyrm/groups.md

@@ -0,0 +1,52 @@
+---
+Title: Groups
+Date: 2025-05-26
+Order: 12
+---
+
+You can join or create a Group with others on Bookwyrm.
+There are many things a group could be made for - a book club, a bunch of friends, whatever makes sense for you.
+Groups can curate book [Lists](lists.html) together, but that's about it right now.
+Currently, the Bookwyrm developers are focusing on other things, not groups, but they will be improved in the future.
+
+To find the groups page, first navigate to your profile, then open the 'Groups' tab.
+
+## Group administration
+
+### Creating a group
+
+On the top right of the groups page is the 'Create group' button. 
+You will then need to give it a name and describe what it is about, before choosing its privacy setting. 
+
+### Group privacy
+
+Groups have the same privacy settings as posts and lists do, except they can't be Followers-only.
+Group membership always requires an invitation from the group's owner, even if it is marked Public.
+For more details, see [here](/privacy-controls.html#groups).
+
+### Adding and removing users
+
+Groups are currently limited only to members on the current instance.
+To add members, search their username in the search bar, then click 'Invite'.
+To remove members, click the 'Remove' button and then 'Confirm'.
+
+## Group membership
+
+### Joining a group
+
+To join a group, you must be on the same instance (website) and be invited by its owner. 
+You will then receive a notification which lets you join.
+The group owner is marked with a star symbol.
+
+### Using group Lists
+
+Group Lists work very similarly to normal Lists, except they are curated by all members of a Group.
+They can be created by any member of a group from the group's homepage.
+
+## Related ideas and discussion on GitHub
+
+Allow users to request to join public groups ([#1840](https://github.com/bookwyrm-social/bookwyrm/issues/1840) on GitHub)
+
+Allow groups to have multiple admins/owners ([#1841](https://github.com/bookwyrm-social/bookwyrm/issues/1841) on GitHub)
+
+Allow groups to include users from multiple instances (ActivityPub) ([#1548](https://github.com/bookwyrm-social/bookwyrm/issues/1548) on GitHub)

content/using_bookwyrm/lists.md

@@ -0,0 +1,75 @@
+---
+Title: Lists
+Date: 2025-05-26
+Order: 6
+---
+
+Lists in Bookwyrm are a way to organise and display similar books together.
+
+The Lists page is accessible from the 'Lists' tab on the main page.
+To see your Lists, click 'Your Lists' below the title or navigate to your profile to the Lists tab.
+
+## Creating a List
+
+To create a List, first select the 'Create List' button on the top right of the page.
+It needs a name, and you can optionally add a description.
+You will then choose how you'd like to curate the List.
+
+## List curation
+
+There are four options for List curation:
+
+- **Closed**: Only you can add and remove books to this list.
+- **Curated**: Anyone can suggest books, subject to your approval.
+- **Open**: Anyone can add books to this list. Only you can remove them.
+- **Group**: [Group](/groups.html) members can add to and remove from this list .
+
+## List privacy
+
+Lists have similar privacy levels as other things in Bookwyrm: Public, Unlisted, Followers and Private.
+See more details on the [privacy controls](/privacy-controls.html#lists) page.
+
+## Adding books to a List
+
+You can add books to any List that you own, "Open" Lists and group-curated Lists of Groups you are a part of.
+You can also suggest books to "Curated" Lists in the exact same way.
+
+There is a side menu (at the bottom on mobile) titled "Add books" or "Suggest books".
+It shows books that you've recently interacted with on Bookwyrm, and a search bar.
+Currently, the search is limited to book titles (see issue [#3607](https://github.com/bookwyrm-social/bookwyrm/issues/3607)).
+Once you find the one you want, use the 'Add' button to add it to the List.
+
+### Notes
+
+You can add a "Note" to each book in a List, which could be used to explain why it was added.
+Notes are added when a book is first added, or at any time with the 'Add notes' button.
+They are displayed with the book when the List is viewed.
+To delete a note, edit it, remove everything in it, then press 'Save'.
+
+### List order
+
+The owner or curator of the List can set a custom display order for the books in it.
+By default, new books are added to the end of the List.
+The position of a book can be changed with the 'List position' box below each book.
+
+## Sorting Lists
+
+You can sort by the manually created list order, book title or average rating, in ascending and descending order.
+
+## Lists sidetab on book pages
+
+There is a sidetab on each books page which shows the Lists it is in, if it is in any.
+This is great for finding similar books suggested by the community.
+
+## Saving Lists
+
+Lists can be 'saved' or bookmarked using the button in the top right when viewing it.
+There is a tab on the main Lists page which shows all your saved Lists, allowing you to find it later.
+
+## Embedding Lists on other websites
+
+If you have a blog or personal website, you are able to embed a List from Bookwyrm onto it.
+Find the section 'Embed this list on a website' below sorting and adding books, then copy the embed code.
+This is in the form of an iframe and can be pasted directly into your website.
+
+

content/using_bookwyrm/main-menu.md

@@ -0,0 +1,124 @@
+---
+Title: Main Menu & Timelines
+Date: 2025-09-06
+Order: 1
+---
+
+## Your Books view
+
+In the top-left of the page (or top of the page on mobile) you will find a small selection of your books. 
+It will include up to 5 books, from your Currently Reading, Read and To Read reading status shelves.
+ 
+To see all of them, you may need to *horizontally* scroll, or pull on the horizontal scroll bar.
+
+If you have 3 or 4 currently reading, the To Read section will not be displayed.
+Similarly, if all 5 are currently reading, the Read section won't be available either.
+However, if you have more than 5 currently reading, it will still only show 5 of them.
+
+By clicking on one of these books, it becomes the focus of the interact and review section. 
+
+### Interact & Review section
+
+Below the display of your books is a section that displays basic information about the selected book, and lets you interact with it.
+It includes:
+
+- The book's title, linking to its main page.
+- The name of the author, linking to the author's page.
+- The [update reading status](/shelves.html#updating-reading-status) button for that book.
+- 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.
+- An input form for the selected type of status.
+
+On mobile, you can temporarily hide this section by pressing the X in the top-right corner of it.
+
+## Reading Goal
+
+If you scroll down below the Your Books and post form, you will see your progress towards your reading goal this year.
+
+As a new user you will see a prompt to set your reading goal when you start using BookWyrm. 
+Otherwise, you can set it by navigating to **Your Profile > Reading Goal**.
+Once set, that is also where you can see your progress and all the books you've read this year.
+
+Try setting a goal that is achievable, and will motivate you to read often.
+
+
+## Search & Barcode Reader
+
+On the top of the home page is a search box, which lets you search for books, authors, users or [lists](/lists.html).
+
+Beside it is a barcode reader which lets you easily find a book by scanning its ISBN barcode using the device camera.
+This is especially useful if you're in a bookstore or the library!
+
+## Timelines
+
+Timelines are filled with **statuses** from people you **follow** on Bookwyrm.
+It's how you keep up with what your friends are reading, reviewing and recommending. 
+They take up 2/3 of the screen, or on mobile are found below the reading goal section.
+
+### Following other users
+
+As a new user, you will be suggested some accounts to follow.
+You can also search for your friend's username to find and follow them.
+If they are using a different BookWyrm website than you (for example, `bookwyrm.social` and `ramblingreaders.org`)
+then you can still follow them - but you will need to use their full account name including the instance domain name, like this:
+
+`user@example.com` or `arthur@ramblingreaders.org`
+
+### Home Timeline
+
+Your Home Timeline is a chronological feed of all the statuses about books posted by people you follow.
+This includes their reading status updates (want to read, started reading, finished, etc), reviews, ratings, comments, and quotes that they've shared.
+Read more about [types of statuses here](/posting-statuses.html).
+
+Your Home Timeline also includes any statuses that people you follow have **boosted**.
+This is similar to reposting or reblogging on other platforms, and means that status has been shared into your Timeline.
+Boosting is the best way to share good reviews with your followers, and helps them find interesting people to follow.
+This is especially useful since there is no algorithm deciding what to show you,
+only the real humans that you've decided to follow.
+
+If you follow people on other fediverse apps, such as Mastodon, you will not find their normal text posts in your timeline.
+However, posts they boost or their replies to other posts will be included in it.
+
+### Books Timeline
+
+Your Books Timeline is a chronological feed that collects statuses posted about books that you have in [your shelves](/shelves.html).
+
+It might not display *all* statuses, if your BookWyrm website doesn't know about some
+
+### Interacting with statuses
+
+You can reply to any status in your timeline to start a discussion, and boost or like the status.
+Under 'More Options' there is a link to send a direct message to the poster, report the status, or block them.
+
+### Filtering Timelines
+
+Both timelines have a Filters menu which lets you filter what types of statuses you'd like to see in it.
+You can include or exclude Reviews, Comments, Quotations, or Everything Else (including reading status updates). 
+Then click the 'Apply filters' button to reload the timeline with the new filters.
+
+A little badge called 'Filters are applied' will be shown after filters are changed, 
+but this disappears after another page reload even though filters are still in effect.
+
+## Navigation to other pages
+
+There are many links within the main menu to navigate to other pages on BookWyrm.
+
+### Top menu bar
+
+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).
+
+On the right hand side is your profile icon and name. 
+When clicked, it has links to your Profile, the Directory of other users, your Direct Messages, Settings, and the Log Out button.
+
+On the far right is the Notifications button. 
+It will display a number if you have unread notifications.
+
+On mobile, some of these options will be collapsed into a 3 dots option which will show them.
+
+### Footer
+
+The website footer also includes links related to the administration of the site, link to this documentation and to re-start the Guided Tour. 
+
+If you are using a free BookWyrm instance, there might be a link to financially support the admins in the footer.
+Public instances require many hours of management and up to several hundred dollars a year to run.
+If you like using your BookWyrm site, please consider supporting them to keep it online and running smoothly!
+

content/using_bookwyrm/posting-statuses.md

@@ -1,15 +1,15 @@
 ---
-Title: Posting statuses
-Date: 2022-04-30
-Order: 1
+Title: Posting Statuses
+Date: 2025-05-26
+Order: 5
 ---
 
 Posting on BookWyrm starts with a book.
 Users can comment on in-progress or recently read books from the "Your books" section, or from a book's landing page.
 From there, users can reply and start a conversation.
 BookWyrm posts can include formatting like bold, italics and links using [Markdown](https://www.markdownguide.org/cheat-sheet/).
 
-If you're familiar with [posting on Mastodon](https://docs.joinmastodon.org/user/posting/), you'll find that BookWyrm statuses have analogous visibility settings, content warnings, and mentions. However, polls, custom emoji, and attachments are not supported yet.
+Bookwyrm statuses also have [visibility settings](/privacy-controls.html) which control who is able to see and interact with them.
 
 ## Types of statuses
 
@@ -26,6 +26,17 @@ There are three types of posts users can create directly in response to books: r
 | Rating | ✔ |  |  |
 | Title field | ✔ |  |  |
 
+#### Spoiler alerts
+
+Spoiler alerts (also known as content warnings) are useful to give people a warning before they read a status that might spoil the plot of a book they want to read.
+Usually just putting "contains spoilers" or something similar is sufficient, but you can be more specific, especially if your status discusses potentially sensitive topics.
+
+#### Star ratings
+
+A star rating can be added to reviews, or added on its own by clicking the stars below a book.
+It is a 5-star scale, and half stars can be added by double clicking on the star.
+For example, if you want to rate 2.5 stars, you'd click on 3 stars then click again on the third star to make it half.
+When viewing a book or reviews, the star ratings are hidden until the user selects "Show rating".
 
 ### Reading status updates