docs: move docs building process to contributor guide #15854
Conversation
This file contains hidden or 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
A-documenting-cargo-itself
|
cc @zdivelbiss if you have any other suggestion to this guide. |
weihanglo
changed the title
zdivelbiss
reviewed
Aug 18, 2025
Comment on lines
60
to
65
| The templates are located in | ||
| <https://github.com/rust-lang/cargo/tree/master/src/doc/man> | ||
| and are converted into three formats: | ||
|
|
||
| The templates are located in <https://github.com/rust-lang/cargo/tree/master/src/doc/man> | ||
| and are converted into three formats: |
There was a problem hiding this comment.
These lines are duplicated (probably unintentionally?).
|
This looks great! I hadn't known this existed (I have a keen eye when it comes to subconsciously skipping over important documents lol). Hopefully adding it to the contribution guide will help others, too. |
ehuss
reviewed
Aug 18, 2025
Comment on lines
64
to
66
| 1. Troff man pages --- used by the `cargo help` command, | ||
| saved in <https://github.com/rust-lang/cargo/tree/master/src/etc/man>. |
There was a problem hiding this comment.
These are also used by distributions to provide man pages which they can install. In the pre-built versions we provide, they are located in $SYSROOT/share/man/man1. (Controlled with the install.mandir bootstrap config option.)
There was a problem hiding this comment.
Updated. Let me know if it is still not good enough.
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.
What does this PR try to resolve?
Pull https://github.com/rust-lang/cargo/blob/71eb84f21aef43c07580c6aed6f806a6299f5042/src/doc/README.md into our contributor guide for visibility.
Also a writing guideline is added to the chapter, as well as some minor polish.
This is created after seeing the contributing frictions in #15838 (comment).
How to test and review this PR?