-
Notifications
You must be signed in to change notification settings - Fork 140
docs: Fix links to man pages #1619
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request fixes broken links to man pages across the documentation by updating filenames to include man page sections and correcting paths. The changes are mostly correct and improve the documentation's usability. I've added a couple of comments on docs/src/SUMMARY.md
to point out some remaining inconsistencies in the content of two of the newly linked man pages for the sake of completeness. Addressing these would make the documentation fully consistent.
Not sure if I'm running this wrong with the new process, but I'm seeing this error trying to sanity check this:
I am assuming I am supposed to run
|
820f71d
to
0288b50
Compare
OK yeah, there was some cruft and bugs here. Pushed another commit that fixes more things. |
Now probably what might make sense is to try to extract this code into a standalone crate to replace https://docs.rs/clap_mangen/latest/clap_mangen/ for those who want what we're doing here (combining hand-maintained dedicated markdown with auto-generated options). |
Followup to bootc-dev#1587 Closes: bootc-dev#1616 Signed-off-by: Colin Walters <walters@verbum.org>
a5c8638
to
00a3ef3
Compare
- Remove duplicated logic between xtask and makefile for converting markdown; it needs to be in xtask as we handle the version substitution there and some other tweaks - Really just make the developer entrypoint `just update-generated` in general - Fix the rendering of booleans - Remove unnecessary emoji from prints Signed-off-by: Colin Walters <walters@verbum.org>
00a3ef3
to
856a7fb
Compare
Followup to #1587 Closes: #1616