A few issues in the User Guide
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Problem
Last night, I started reading the mdbook user guide. While most of it is fine, I noticed a few strange issues. Well, being a Rust beginner, and not a native speaker, some might not be real errors.
https://rust-lang.github.io/mdBook/guide/reading.html
Navigation
The arrow buttons at the bottom of the page can be used to navigate to the previous or the next chapter.
For me, there are arrows at the left and right, but not at the bottom. Is this a feature of the most recent version, or just an outdated documentation. Or have I misundrstand it?
And: Repeating the wording is bad style, but perhaps that is a result of auto-generated test:
The arrow buttons at the bottom of the page can be used to navigate to the previous or the next chapter.
The left and right arrow keys on the keyboard can be used to navigate to the previous or the next chapter.
https://rust-lang.github.io/mdBook/guide/creating.html
book.toml
In the root of your book, there is a book.toml file which contains settings for describing how to build your book. This is written in the TOML markup language.
This is an awkward wording. It should be something like
At the root of your book folder, there is a book.toml file that contains settings for configuring the build process of your book. This file is written in the TOML markup language.
Source files
All other files in the src directory will be included in the output. So if you have images or other static files, just include them somewhere in the src directory.
I really can not imagine that "All other files in the src directory will be included in the output." Should it be something like
All files in the src directory might be included in the output. So if you have images or other static files, just include them somewhere in the src directory.
Publishing a book
For more information about publishing and deploying, check out the Continuous Integration chapter for more.
Remove the trailing "for more".
Steps
Read the User Guide
Possible Solution(s)
Perhaps a native speaker can fix it.
Notes
OK, if you think it is just good enough, then I will close this issue in a few days.
Version
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the linked guide/reading.html and guide/creating.html pages in the User Guide, checking the navigation wording and each quoted passage against the current rendered behavior. Confirm which statements are inaccurate or awkward, then update the affected documentation so the navigation description and book.toml, source-file, and publishing text are accurate and grammatically clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100