feat: generate and package man pages via clap-mangen - #838
Open
aishagbadamosi wants to merge 1 commit into
Open
Conversation
Add build-time man page generation using clap-mangen (v0.2.21) and a runtime `starforge man` subcommand for viewing/installing them. Changes: - build.rs generates 75 man pages (starforge.1 + all subcommands) to man/ - `starforge man generate <page>` prints roff to stdout for piping into man(1) - `starforge man install --directory <dir>` copies pages to a target path - `starforge man list` shows all available pages - Release tarballs (Linux/macOS) now include man/ directory - install.sh and Homebrew formula install man pages to system paths - 9 integration tests covering primary flow, boundary, and failure cases closes Nanle-code#675
|
@aishagbadamosi Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Add build-time man page generation using clap-mangen (v0.2.21) and a runtime
starforge mansubcommand for viewing/installing them.Changes:
starforge man generate <page>prints roff to stdout for piping into man(1)starforge man install --directory <dir>copies pages to a target pathstarforge man listshows all available pagescloses #675
Description
Add build-time man page generation using clap-mangen (v0.2.21) and a runtime
starforge mansubcommand for viewing/installing them.Changes:
starforge man generate <page>prints roff to stdout for piping into man(1)starforge man install --directory <dir>copies pages to a target pathstarforge man listshows all available pagesCloses [2026 Documentation] Generate and package man pages #675
Type of Change
Changes Made
Testing
How has this been tested?
Describe the tests you ran and how to reproduce them.
Test Coverage
Describe what scenarios have been tested:
Code Quality Checklist
cargo fmt)cargo clippy -- -D warnings)Breaking Changes
If checked, describe the breaking changes and migration path:
Documentation
Screenshots (if applicable)
Add screenshots or GIFs for UI changes.
Additional Context
Add any other context about the PR here.
Note: Make sure all tests pass locally before submitting:
cargo test cargo fmt --all cargo clippy -- -D warnings