Skip to content

docs: improve CLI command descriptions for autogenned docs#83

Merged
pcfreak30 merged 1 commit into
developfrom
docs/command-descriptions
Jun 13, 2026
Merged

docs: improve CLI command descriptions for autogenned docs#83
pcfreak30 merged 1 commit into
developfrom
docs/command-descriptions

Conversation

@pcfreak30

@pcfreak30 pcfreak30 commented Jun 13, 2026

Copy link
Copy Markdown
Member
  • 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

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:

  • Replace placeholder QmHash with realistic CIDv1 examples (bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e) throughout all command descriptions and examples
  • Update --confirm to --force in unpin-related commands and descriptions to reflect the actual flag name
  • Add "Shortcut for..." prefixes to alias commands (list, pin, status, unpin) to clarify they are shortcuts to their canonical commands (pins ls, pins add, pins status, pins rm)
  • Simplify and clarify descriptions — remove redundant parentheticals like "(IPFS hash)" and "(Content Identifier)" from flag usage, use more concise and active language (e.g., "Check whether a pin has completed" instead of "Check the status of a pin to see if it has been completed")
  • Mask sensitive data in auth examples — replace actual password values with ***
  • Use generic "token" terminology instead of "jwt-token" in the auth command
  • Add clarifying context — e.g., metadata explanation in pins update, operations description in operations list

@kody-ai

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
@pcfreak30 pcfreak30 force-pushed the docs/command-descriptions branch from b6352f1 to b102a3f Compare June 13, 2026 19:30
@kody-ai

kody-ai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.

  • Validate Business Logic: Ask Kody to validate your code against business rules by adding a comment with the @kody -v business-logic command.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug
Performance
Security
Business Logic

Access your configuration settings here.

@github-actions

Copy link
Copy Markdown

Code Coverage Report

Total Coverage: 53.4%

Generated from commit: bac98f7
Repository: LumeWeb/pinner-cli

@pcfreak30 pcfreak30 merged commit d4b7422 into develop Jun 13, 2026
9 checks passed
@pcfreak30 pcfreak30 deleted the docs/command-descriptions branch June 13, 2026 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant