docs(cli): update latest cli documentation #3678
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request updates the documentation for the AsyncAPI CLI by modifying the description of 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
|
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 #3678 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 732 732
=========================================
Hits 732 732 ☔ 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: 1
📜 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
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/tools/cli/usage.md
542-542: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (1)
markdown/docs/tools/cli/usage.md (1)
540-547: LGTM! The updated description is more comprehensive.The new description better reflects the full capabilities of the
asyncapi newcommand by including projects, specification files, and templates.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
542-542: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
| ``` | ||
| USAGE | ||
| $ asyncapi new [-h] [-n <value>] [-e <value>] [-s] [-p <value>] [--no-tty] | ||
|
|
||
| FLAGS | ||
| -e, --example=<value> | ||
| name of the example to use. Available examples are: | ||
| - simple-asyncapi.yml | ||
| - adeo-kafka-request-reply-asyncapi.yml | ||
| - anyof-asyncapi.yml | ||
| - application-headers-asyncapi.yml | ||
| - correlation-id-asyncapi.yml | ||
| - websocket-gemini-asyncapi.yml | ||
| - gitter-streaming-asyncapi.yml | ||
| - kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml | ||
| - kraken-websocket-request-reply-multiple-channels-asyncapi.yml | ||
| - mercure-asyncapi.yml | ||
| - not-asyncapi.yml | ||
| - operation-security-asyncapi.yml | ||
| - oneof-asyncapi.yml | ||
| - rpc-client-asyncapi.yml | ||
| - rpc-server-asyncapi.yml | ||
| - slack-rtm-asyncapi.yml | ||
| - tutorial.yml | ||
| - streetlights-kafka-asyncapi.yml | ||
| - streetlights-operation-security-asyncapi.yml | ||
| - streetlights-mqtt-asyncapi.yml | ||
|
|
||
| -h, --help | ||
| Show CLI help. | ||
|
|
||
| -n, --file-name=<value> | ||
| name of the file | ||
|
|
||
| -p, --port=<value> | ||
| port in which to start Studio | ||
|
|
||
| -s, --studio | ||
| open in Studio | ||
|
|
||
| --no-tty | ||
| do not use an interactive terminal | ||
| $ asyncapi new |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add language specifier to the code block.
The code block is missing a language specifier, which is required by markdown linting rules.
Apply this diff to fix the issue:
-```
+```sh
$ asyncapi new🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
542-542: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
asyncapi-bot
deleted the
update-cli-docs-755339a24bbc49cc802e1e450fd709081316674d
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit