chore: updates the CLI description in docs and help text#75
Conversation
Updates the CLI description in docs and help text to better represent the APIs it can interact with.
|
Important Review skippedAuto reviews are disabled on this repository. To trigger a review, include ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the CLI’s top-level description across the README, runware --help text, and generated docs to reflect broader Runware API capabilities beyond just “inference”.
Changes:
- Updated README introduction to refer to the Runware API (not specifically the inference API) and expanded the capability summary.
- Updated Cobra root command
Short/Longhelp text to match the new positioning. - Updated generated docs (
docs/*.md) to reflect the new root command description in Synopsis and SEE ALSO sections.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates the project’s one-paragraph description and adds an expanded capability summary. |
| internal/cmd/root.go | Updates Cobra root command Short/Long help text used by runware --help and doc generation. |
| docs/runware.md | Updates generated root command docs (title line and synopsis). |
| docs/runware_version.md | Updates generated SEE ALSO root description string. |
| docs/runware_upload.md | Updates generated SEE ALSO root description string. |
| docs/runware_run.md | Updates generated SEE ALSO root description string. |
| docs/runware_result.md | Updates generated SEE ALSO root description string. |
| docs/runware_preset.md | Updates generated SEE ALSO root description string. |
| docs/runware_ping.md | Updates generated SEE ALSO root description string. |
| docs/runware_model.md | Updates generated SEE ALSO root description string. |
| docs/runware_config.md | Updates generated SEE ALSO root description string. |
| docs/runware_completion.md | Updates generated SEE ALSO root description string. |
| docs/runware_auth.md | Updates generated SEE ALSO root description string. |
| docs/runware_account.md | Updates generated SEE ALSO root description string. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updates the CLI description in docs and help text to better represent the APIs it can interact with.