Add generated command reference docs#294
Merged
Merged
Conversation
Add tools/gen-docs that uses cobra/doc to generate per-command markdown pages under docs/commands/. A new CI job regenerates the docs and fails if the checked-in files drift from the source. Also fix JSON schema $id URLs to point to raw.githubusercontent.com for direct fetch.
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
tools/gen-docsusingcobra/docto generate per-command markdown pages underdocs/commands/(37 files covering all commands and subcommands).$idURLs to useraw.githubusercontent.comfor direct fetch.Test plan
go run ./tools/gen-docssucceeds and produces identical outputgo build ./...passes with new dependenciesdocsjob passes (regenerate +git diff --exit-code)docs/commands/renders correctly on GitHub