Add gen-docs tool for reference documentation#499
Open
lennessyy wants to merge 1 commit into
Open
Conversation
Walks the urfave/cli command tree to generate MDX reference pages for each tcld command. Outputs one page per top-level command plus an index page. Escapes angle brackets and curly braces for MDX compatibility. Usage: go run ./cmd/gen-docs -output <dir>
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.
Summary
Add a
cmd/gen-docstool that generates MDX reference documentation pages by walking the urfave/cli command tree.New*Commandconstructors (with nil client functions, which are safe since clients are only used at runtime)Usage
Companion PR
Test plan
go build ./cmd/gen-docs/compilesgo run ./cmd/gen-docs -output dist/docsgenerates 16 files (15 commands + index)