docs(cli): update latest cli documentation #3576
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request focuses on updating file extension references from Changes
Suggested labels
Suggested reviewers
Possibly related PRs
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 #3576 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 668 668
=========================================
Hits 668 668 ☔ View full report in Codecov by Sentry. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3576--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: 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 (0.37.0)
markdown/docs/tools/cli/usage.md
589-589: Column: 86
Hard tabs
(MD010, no-hard-tabs)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
| @@ -586,7 +586,7 @@ DESCRIPTION | |||
| EXAMPLES | |||
| $ asyncapi new - start creation of a file in interactive mode | |||
|
|
|||
| $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode | |||
| $ asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode | |||
There was a problem hiding this comment.
LGTM! File extension update looks good.
The change from .yml to .yaml in the example command ensures consistency in file extension usage across documentation.
Fix formatting: Replace hard tab with spaces.
There's a hard tab in the line that should be replaced with spaces for consistent formatting.
Apply this diff to fix the formatting:
- - create a new file with a specific name, using one of the examples and without interactive mode
+ - create a new file with a specific name, using one of the examples and without interactive mode📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| $ asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode | |
| $ asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode |
🧰 Tools
🪛 Markdownlint (0.37.0)
589-589: Column: 86
Hard tabs
(MD010, no-hard-tabs)
asyncapi-bot
deleted the
update-cli-docs-639dcab35e9143a730a7cd33262093e20e9d507e
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
.yamlfile extensions consistently instead of.ymlfor AsyncAPI files.