manual: Convert to mdbook #19015
Merged
manual: Convert to mdbook #19015
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
the
S-waiting-on-review
Wilfred
force-pushed
the
mdbook
branch
3 times, most recently
from
2724f7c to
3380e4e
Compare
Split manual.adoc into markdown files, one for each chapter. For the parts of the manual that are generated from source code doc comments, update the comments to use markdown syntax and update the code generators to write to `generated.md` files. For the weekly release, stop copying the .adoc files to the `rust-analyzer/rust-analyzer.github.io` at release time. Instead, we'll sync the manual hourly from this repository. See rust-analyzer/rust-analyzer.github.io#226 for the sync. This PR should be merged first, and that PR needs to be merged before the next weekly release. This change is based on rust-lang#15795, but rebased and updated. I've also manually checked each page for markdown syntax issues and fixed any I encountered. Co-authored-by: Lukas Wirth <lukastw97@gmail.com> Co-authored-by: Josh Rotenberg <joshrotenberg@gmail.com>
That seems a bit excessive, once a day should suffice I feel like. Let's merge this next week after the new release then. |
|
Woohoo, glad to see this is still alive! Happy to help out if I can. |
|
@lnicola do we wanna merge this then? (and change the cron job time on the webpage repo PR?) Asking you since it is release related and so might cause you trouble |
|
@Veykril let's get this thing out of the gate. We can tweak the cron job later, at least this way we'll know it it's working. |
|
Big thanks to the people involved, especially @joshrotenberg of course :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split manual.adoc into markdown files, one for each chapter.
For the parts of the manual that are generated from source code doc comments, update the comments to use markdown syntax and update the code generators to write to
generated.mdfiles.For the weekly release, stop copying the .adoc files to the
rust-analyzer/rust-analyzer.github.ioat release time. Instead, we'll sync the manual hourly from this repository.See rust-analyzer/rust-analyzer.github.io#226 for the sync. This PR should be merged first, and that PR needs to be merged before the next weekly release.
This change is based on #15795, but rebased and updated. I've also manually checked each page for markdown syntax issues and fixed any I encountered.