docs(cli): update latest cli documentation #3314
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe changes involve updates to the Changes
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 #3314 +/- ##
=======================================
Coverage 53.17% 53.17%
=======================================
Files 21 21
Lines 598 598
=======================================
Hits 318 318
Misses 280 280 ☔ 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
🧹 Outside diff range and nitpick comments (1)
markdown/docs/tools/cli/usage.md (1)
715-715: Consider adding a language specifier to the fenced code blockTo improve rendering and enable proper syntax highlighting, consider adding a language specifier to the fenced code block. For example, you could change it to:
-``` +```shThis change will enhance the readability of the command output in the documentation.
🧰 Tools
🪛 Markdownlint
715-715: 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 (26 hunks)
🧰 Additional context used
🪛 Markdownlint
markdown/docs/tools/cli/usage.md
715-715: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (6)
markdown/docs/tools/cli/usage.md (6)
2-2: LGTM: Title formatting updateThe change from double quotes to single quotes for the title is a good stylistic improvement. It maintains consistency with Markdown syntax.
30-30: Version update approvedThe CLI version has been correctly updated from 2.5.0 to 2.7.1 in the usage example. This change ensures that the documentation accurately reflects the current version of the software.
41-64: Improved list formattingThe change from dash-prefixed to asterisk-prefixed list items enhances consistency with standard Markdown unordered list syntax. This improvement makes the document more compatible with various Markdown renderers and easier to maintain.
102-102: Source code reference updatedThe GitHub URL has been correctly updated to reflect the new version (v2.7.1). This change ensures that readers can access the most up-to-date source code for the CLI commands.
713-714: Enhanced command descriptionThe description for the
asyncapi startcommand has been improved. It now explicitly mentions support for launching AsyncAPI Studio, providing clearer information about the command's functionality. The multi-line formatting also enhances readability.Also applies to: 720-721
Line range hint
1-772: Overall documentation update looks greatThe changes made to this file have significantly improved the documentation:
- Consistent version updates throughout the document (2.5.0 to 2.7.1).
- Improved Markdown formatting for better readability and compatibility.
- Enhanced descriptions for commands, particularly for
asyncapi start.These updates ensure that the documentation accurately reflects the current state of the AsyncAPI CLI and follows good documentation practices.
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3314--asyncapi-website.netlify.app/ |
asyncapi-bot
deleted the
update-cli-docs-9e107c92ea7b7b432ed33986ec7c943b60e2e40f
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit