docs(cli): update latest cli documentation #3405
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request updates the AsyncAPI CLI documentation to reflect changes introduced in version 2.9.0. It includes the addition of a new command, Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
CodeRabbit Configuration File (
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
devilkiller-ag,
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3405 +/- ##
=======================================
Coverage 67.77% 67.77%
=======================================
Files 21 21
Lines 664 664
=======================================
Hits 450 450
Misses 214 214 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3405--asyncapi-website.netlify.app/ |
![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
🧹 Outside diff range and nitpick comments (1)
markdown/docs/tools/cli/usage.md (1)
383-398: Add language specifier to code blockThe fenced code block is missing a language specifier. This should be fixed to comply with markdown best practices.
Apply this diff:
-``` +```sh USAGE $ asyncapi format [SPEC-FILE] -f yaml|yml|json [-h] [-o <value>]🧰 Tools
🪛 Markdownlint
383-383: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
markdown/docs/tools/cli/usage.md(31 hunks)
🧰 Additional context used
🪛 Markdownlint
markdown/docs/tools/cli/usage.md
383-383: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (4)
markdown/docs/tools/cli/usage.md (4)
30-30: Version update confirmed
The CLI version has been updated to 2.9.0 as mentioned in the PR summary.
379-400: New format command documentation looks good
The new asyncapi format command is well documented with clear usage instructions, arguments, flags, and description.
🧰 Tools
🪛 Markdownlint
383-383: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
346-346: Output option added to diff command
The -o, --output flag has been correctly added to the diff command with appropriate description.
Also applies to: 356-356
775-775: Output option added to validate command
The -o, --output flag has been correctly added to the validate command with appropriate description.
Also applies to: 782-782
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
New Features
asyncapi format [SPEC-FILE]for converting AsyncAPI documents to YAML, YML, or JSON.Updates
asyncapi diffandasyncapi validatecommands.