docs: improve CLI command descriptions for autogenned docs#83
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
- Replace passive voice with imperative mood across all commands - Use CIDv1 (bafy...) placeholders instead of CIDv0 (Qm...) - Update root examples: --confirm→--force, JWT token→auth token - Clarify flag descriptions (CID reference→CID, etc.) - Standardize argument syntax in descriptions
b6352f1 to
b102a3f
Compare
Kody Review CompleteGreat news! 🎉 Keep up the excellent work! 🚀 Kody Guide: Usage and ConfigurationInteracting with Kody
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
Code Coverage ReportTotal Coverage: 53.4% Generated from commit: bac98f7 |
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.
Improve CLI command descriptions for auto-generated documentation
This PR updates and improves CLI command descriptions across the codebase to produce better auto-generated documentation. Key changes include:
QmHashwith realistic CIDv1 examples (bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e) throughout all command descriptions and examples--confirmto--forcein unpin-related commands and descriptions to reflect the actual flag namelist,pin,status,unpin) to clarify they are shortcuts to their canonical commands (pins ls,pins add,pins status,pins rm)***pins update, operations description inoperations list