docs(cli): update latest cli documentation #3691
Conversation
asyncapi-bot
requested review from
quetzalliwrites,
TRohit20 and
asyncapi-bot-eve
as code owners
WalkthroughThis pull request updates the AsyncAPI CLI documentation for the Changes
Sequence Diagram(s)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 #3691 +/- ##
=========================================
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: 0
🧹 Nitpick comments (1)
markdown/docs/tools/cli/usage.md (1)
606-606: Replace hard tabs with spaces.
Static analysis indicates that line 606 contains hard tabs before the dash in the example. Replacing these with spaces will align the document with markdownlint guidelines and improve consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
606-606: Hard tabs
Column: 22(MD010, no-hard-tabs)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
markdown/docs/tools/cli/architecture.md(1 hunks)markdown/docs/tools/cli/usage.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/tools/cli/architecture.md
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...odels used during generation. - new/: Create a new AsyncAPI project, specific...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/tools/cli/usage.md
606-606: Hard tabs
Column: 22
(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
🔇 Additional comments (3)
markdown/docs/tools/cli/architecture.md (1)
25-25: Clarify the scope of the "new" command directory.
The updated description for thenew/directory now explicitly states that it can be used to create new AsyncAPI projects, specification files, or templates for clients and applications. This expanded wording aligns perfectly with the PR objectives, improving the documentation clarity regarding the command's capabilities.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...odels used during generation. -new/: Create a new AsyncAPI project, specific...(UNLIKELY_OPENING_PUNCTUATION)
markdown/docs/tools/cli/usage.md (2)
541-552: Refine the "asyncapi new" command description.
The "asyncapi new" command section now outlines that it supports creating AsyncAPI projects, specification files, or templates. This broader description ensures that users understand the multiple use cases available.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
544-544: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
555-612: Improve clarity for "asyncapi new file" usage.
The usage documentation now distinctly separates the file creation case by introducing the explicit command$ asyncapi new file, along with detailed flags and examples. This update provides clearer guidance to users on how to create a new AsyncAPI file, directly addressing the PR objectives.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
559-559: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
606-606: Hard tabs
Column: 22(MD010, no-hard-tabs)
608-608: Hard tabs
Column: 84(MD010, no-hard-tabs)
asyncapi-bot
deleted the
update-cli-docs-f8734238e6caf4fb4159a8bf48eb4ce8987ade03
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit