Restructure README into focused topic docs#298
Merged
Conversation
Condense the README into a concise landing page with quickstart, common workflows, features, and installation. Move detailed content into docs/automation.md (JSON output, auth, piping, exit status) and docs/sharing.md (shared-link workflows). Enrich generated command docs with a metadata section showing structured output support, stdin/stdout behavior, and destructive level.
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
docs/automation.md(JSON output, auth, piping, exit status) anddocs/sharing.md(shared-link workflows).Test plan
go test ./... -count=1passesgolangci-lint run ./...cleango run ./tools/gen-docsoutput matches committeddocs/commands/