docs(cli): update latest cli documentation #3689
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughThe documentation for the AsyncAPI CLI usage has been updated to simplify the command signatures. Optional proxy parameters ([PROXYHOST] and [PROXYPORT]) have been removed from the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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
|
✅ 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 #3689 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
asyncapi-bot
deleted the
update-cli-docs-67d7e8f206d71181a9c3ca93df1f38ed550ff22b
branch
![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 (3)
markdown/docs/tools/cli/usage.md (3)
317-317: Fenced Code Block: Specify LanguageThe fenced code block starting at this line does not have a language specifier. Adding one (e.g. use
```shinstead of just```) will improve readability and comply with markdownlint recommendations.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
317-317: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
663-663: Fenced Code Block: Add Language IdentifierConsider adding a language identifier to the fenced code block at this line. For instance, replacing the opening fence with
```shcan enhance syntax highlighting.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
663-663: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
767-767: Fenced Code Block: Include Language TagThe fenced code block here would benefit from specifying a language (e.g.
sh) to improve clarity and achieve better compliance with markdownlint rules.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
767-767: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/tools/cli/usage.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/tools/cli/usage.md
317-317: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
663-663: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
767-767: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (4)
markdown/docs/tools/cli/usage.md (4)
55-55: Updated Command Listing forasyncapi convertThe command listing now reads
asyncapi convert [SPEC-FILE]which correctly removes the optional[PROXYHOST]and[PROXYPORT]parameters in line with the PR objectives. Please double-check that the detailed usage (the code block under the## asyncapi convert [SPEC-FILE]section) is updated consistently.
65-65: Updated Command Listing forasyncapi optimizeThe simplified signature
asyncapi optimize [SPEC-FILE]now appears without proxy parameters, aligning with the intended changes. Verify that all examples and the detailed usage for this command (later in the document) reflect this update.
69-69: Updated Command Listing forasyncapi validateThe command listing has been revised to
asyncapi validate [SPEC-FILE], removing the optional proxy settings. Ensure that the in-depth usage section and any examples also match this simplified signature.
763-764: Updated Command Header forasyncapi validateThe header for the validate command now shows
asyncapi validate [SPEC-FILE], which is in line with the removal of proxy parameters. Please confirm that any internal references or auto-generated explanations no longer mention the proxy flags.
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
convert,optimize, andvalidatecommands to reflect the streamlined design.