Generate CLI reference docs - #224
Open
nathanjcochran wants to merge 4 commits into
Open
Conversation
nathanjcochran
force-pushed
the
nathan/generate-docs
branch
from
September 9, 2026 21:17
0329407 to
c97c5a5
Compare
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.
This adds generated Markdown reference documentation for every CLI command, following the same approach ghost already uses. A small
cmd/generate-docstool walks the Cobra command tree and writes one page per command todocs/cli/, so the reference always reflects the real help text rather than something maintained by hand.Generation is wired into
go generate ./..., alongside the existing API client and mock generation. That gives contributors a single command to remember, and it means the existing CI check now fails whenever a command, flag, or help text changes without the docs being regenerated. The CI step also picks up newly generated files, so a new command can't land without its reference page.To keep the output identical across machines, the default config directory is now shown in help as
~/.config/tigerand expanded when the config loads, instead of being expanded up front into a machine-specific path.