feat: add generate-docs command with markdown and man page support#81
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
![kody-ai[bot]](https://avatars.githubusercontent.com/in/413034?s=60&v=4){kind=small}
Add urfave/cli-docs/v3 integration for generating CLI documentation: - pinner generate-docs markdown - outputs full command tree as markdown - pinner generate-docs man - outputs man page (section configurable) - Both support --output/-o flag to write to file - GoReleaser generates man page in before hooks - Man page included in archives and deb/rpm packages
Code Coverage ReportTotal Coverage: 53.4% Generated from commit: a859563 |
pcfreak30
force-pushed
the
feat/cli-docs-generation
branch
from
0ad651f to
360e1c6
Compare
Kody Review CompleteGreat news! 🎉 Keep up the excellent work! 🚀 Kody Guide: Usage and ConfigurationInteracting with Kody
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
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
1 participant
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 urfave/cli-docs/v3 integration for generating CLI documentation:
Add a
generate-docsCLI command that produces documentation in markdown or man page formatThis PR introduces a new
generate-docscommand (categorized under "System") with two subcommands:markdown: Generates CLI documentation in markdown format, with an optional--output/-oflag to write to a file (defaults to stdout).man: Generates CLI documentation as a man page, with an optional--output/-oflag and a--sectionflag (defaults to section 1).The release pipeline (GoReleaser) is updated to automatically generate a man page during builds, include it in release archives, and install it to
/usr/share/man/man1/pinner.1in Linux packages (nfpms). The root command registration and related tests are also updated to include the new subcommand.