cli: add Cobra Example blocks and tighten flag descriptions#45
Merged
Conversation
The auto-generated CLI reference now lives at https://skillsctl.dev/cli/reference/ but inherited terse Short descriptions and no Examples from the original Cobra wiring. Add Example to every leaf command, add Long where the command name is not self-evident (root, install, publish, auth login, config), and clarify flag descriptions that left the expected format implicit (--digest's sha256: form, --name/--version constraints on publish, --api-url precedence on root). No behavior changes; metadata only. Test suite and golangci-lint pass. Closes #44
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
The architecture review on #43 deliberately kept the generated reference terse-but-exhaustive while hand-written pages under `docs/site/content/cli/*.md` carry narrative. This PR fills out the reference within that boundary - examples and short Longs, not duplicated prose.
Closes #44.
Test plan