docs(cli): update latest cli documentation #3693
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughThe pull request updates the AsyncAPI CLI usage documentation in Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant C as AsyncAPI CLI
participant S as Studio
U->>C: Run "asyncapi start studio [SPEC-FILE]"
alt SPEC-FILE provided
C->>S: Process specified AsyncAPI file
else No SPEC-FILE provided
C->>S: Begin default startup
end
S-->>C: Return studio linkage confirmation
C-->>U: Display startup result
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 #3693 +/- ##
=========================================
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-4ecdde4d1eb2292ce2b63789f406b6dbfc210c49
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 (2)
markdown/docs/tools/cli/usage.md (2)
604-606: Replace Hard Tabs with Spaces
Static analysis has flagged the use of hard tabs in these example commands. Replacing hard tabs with spaces will improve styling consistency and adhere to Markdown best practices.Example Diff:
- $ asyncapi new - start creation of a file in interactive mode + $ asyncapi new - start creation of a file in 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 + $ 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-cli2 (0.17.2)
604-604: Hard tabs
Column: 17(MD010, no-hard-tabs)
606-606: Hard tabs
Column: 86(MD010, no-hard-tabs)
315-315: Specify Language for Fenced Code Blocks
Some fenced code blocks (as flagged on lines 315 and 744) do not have an explicit language specified. Adding a language (e.g., replacing the opening fence with```bashfor shell commands) enhances syntax highlighting and resolves Markdown lint warnings.Also applies to: 744-744
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
315-315: 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(33 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/tools/cli/usage.md
315-315: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
604-604: Hard tabs
Column: 17
(MD010, no-hard-tabs)
606-606: Hard tabs
Column: 86
(MD010, no-hard-tabs)
744-744: 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 (3)
markdown/docs/tools/cli/usage.md (3)
29-30: Verify Updated Version and Node Information
The updated output now displays@asyncapi/cli/2.16.4 linux-x64 node-v18.20.6, which correctly reflects the version bump and updated Node.js version. Please ensure that this matches the actual release details.
41-67: Consistent Bullet List Formatting
Switching from hyphens to asterisks for the command list improves visual consistency across the documentation. This change enhances readability and aligns with our formatting guidelines.
740-758: Enhanced Command Signature for Studio Start
The update to theasyncapi start studiocommand—now accepting an optional[SPEC-FILE]argument—provides greater flexibility for linking with an AsyncAPI file. Ensure that all related documentation and source references are updated accordingly.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
744-744: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit