docs(cli): update latest cli documentation #4197
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
User->>CLI: Run `asyncapi validate` with flags
CLI->>Validator: Pass flags including --suppressWarnings/--suppressAllWarnings
Validator->>CLI: Validate and filter warnings as per flags
CLI->>User: Output diagnostics with specified warnings suppressed
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 failed.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4197 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![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)
817-819: Fix grammar in suppressWarnings description
The sentence "Can be passed multiple times." lacks a subject. Consider rephrasing to "It can be passed multiple times."
824-830: Unify example annotation style
Other commands use inline comments (e.g.,--example=default-example.yaml - create a new file...). Consider converting the explanatory lines for--suppressWarningsand--suppressAllWarningsto inline explanations with a dash for consistency.
📜 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
🪛 LanguageTool
markdown/docs/tools/cli/usage.md
[style] ~817-~817: To form a complete sentence, be sure to include a subject.
Context: ...o suppress from the diagnostics output. Can be passed ...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Lighthouse CI
🔇 Additional comments (3)
markdown/docs/tools/cli/usage.md (3)
795-798: Approve updated USAGE section
TheUSAGEblock now correctly includes the new--suppressWarningsand--suppressAllWarningsflags. Formatting and indentation align with other commands.
805-814: Approve refined flag descriptions
The descriptions for-o,-w,--diagnostics-format,--fail-severity,--[no-]log-diagnostics,--proxyHost, and--proxyPortare now clearer, consistently capitalized, and end with periods.
821-823: Approve updated DESCRIPTION heading
Changing to "Validate an AsyncAPI file." uses consistent sentence case and aligns with other command descriptions.
akshatnema
deleted the
update-cli-docs-0754d1d60389e47d081464fe10b18a9bb4e0033c
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit