-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Move manual to mdbook #13330
Move manual to mdbook #13330
Conversation
Some considerations for the navigation related to automatically generated content ... Right now, because the four automatically generated sections (Configuration, Assists, Features and Diagnostics) produce a single markdown file for their respective items, their contents are only displayed on the main page using the mdbook toc preprocessor. Note specifically that the navigation does not have the ability to expand down and show the contents) For example: While my instinct would be to make them separate, in this case it seems like not cluttering the navigation with excessively long sub item lists is preferable, and just having them exist on a single page makes it easier to CtrlF through (as I believe is pointed out as a desirable feature in #9504). Adding to the searchability, the mdbook built-in search gives good results when searching for, say, a specific assist: More screenshots with other themes ... Contributing guide (previously the content in |
This PR converts the current single page asciidoc manual into an mdbook project in
docs/manual
.Todo list:
docs/manual
xtask/src/release.rs
files to point to the.md
filesdocs/dev
to new manual (optional, do it later?)Fixes #9504.
(This is a 'take 2' on #10791. I found a much cleaner and consistent way to convert a lot of the
adoc
with pandoc and it was easier to start fresh with the latest master).