-
Notifications
You must be signed in to change notification settings - Fork 3.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README - mdBook in Cargo.toml #3860
Labels
Comments
Thanks for the suggestion! We'll need to decide whether we want to add that automation (automation is awesome but also has to be maintained over time!), but having a handy example is fantastic! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
π I have searched open and closed issues and pull requests for duplicates, using these search terms:
β I have checked the latest
main
branch to see if this has already been fixed, in this file:πURL to the section(s) of the book with this problem:
README.md, line 27
π¬ Description of the problem:
The readme says "Building the book requires mdBook, ideally the same version that
rust-lang/rust uses in this file". However, mdBook being in its own category rather than under the generic "dependencies" section makes it easy to miss, creating the potential for confusion. (Frankly, when I started typing this issue, I myself was convinced it was missing, and only noticed it after doing a ctrl+f search to double check)
π¨ Suggested fix:
Dynamically insert the correct version for mdBook in the readme in order to make the documentation more clear, concise, and welcoming. This can be done with minimal difficulty via GitHub Actions:
Update README.md β
Create workflow π¬
Cheers!
--DJ
The text was updated successfully, but these errors were encountered: