docs(cli): update latest cli documentation #3524
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request introduces a minor documentation update for the Changes
Suggested ReviewersPoem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
asyncapi-bot
requested review from
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3524 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 668 668
=========================================
Hits 668 668 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
markdown/docs/tools/cli/usage.md (1)
738-738: Add a comma for better readability.Add a comma after "in place" to improve readability.
-Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file. +Beautify the AsyncAPI spec file (indentation, styling) in place, or output the formatted spec to a new file.🧰 Tools
🪛 LanguageTool
[uncategorized] ~738-~738: Possible missing comma found.
Context: ...API spec file (indentation, styling) in place or output the formatted spec to a new f...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/tools/cli/usage.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/tools/cli/usage.md
[uncategorized] ~738-~738: Possible missing comma found.
Context: ...API spec file (indentation, styling) in place or output the formatted spec to a new f...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
markdown/docs/tools/cli/usage.md (1)
738-738: LGTM! Description is now more comprehensive.
The updated description provides better clarity by explicitly mentioning the beautification aspects (indentation, styling) and the available output options (in-place or new file).
🧰 Tools
🪛 LanguageTool
[uncategorized] ~738-~738: Possible missing comma found.
Context: ...API spec file (indentation, styling) in place or output the formatted spec to a new f...
(AI_HYDRA_LEO_MISSING_COMMA)
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3524--asyncapi-website.netlify.app/ |
|
/rtm |
asyncapi-bot
deleted the
update-cli-docs-0011ca97f2f6e740c7f621b6123468828ac067e3
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
asyncapi pretty SPEC-FILEcommand to provide clearer explanation of its formatting capabilities