-
-
Notifications
You must be signed in to change notification settings - Fork 743
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(cli): update latest cli documentation #3552
docs(cli): update latest cli documentation #3552
Conversation
WalkthroughThe pull request updates the AsyncAPI CLI documentation to include new proxy-related parameters for commands like Changes
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 #3552 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 668 668
=========================================
Hits 668 668 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
markdown/docs/tools/cli/usage.md (2)
322-323
: Fix inconsistencies in proxy parameter documentation.The proxy parameter descriptions have inconsistencies and typos:
- Inconsistent spacing in "ProxyHost" vs "Proxy Host"
- Duplicate word in "Port number number"
Apply these documentation fixes:
- Name of the Proxy Host + Name of the proxy host - Name of the ProxyHost + Name of the proxy host - Port number number for the proxyHost + Port number for the proxy hostAlso applies to: 334-335, 710-711, 724-725, 814-815, 827-828
315-315
: Add language specifiers to code blocks.The code blocks in the command usage sections should specify the language for proper syntax highlighting.
Add
sh-session
as the language specifier to the code blocks:-``` +```sh-sessionAlso applies to: 702-702, 806-806
🧰 Tools
🪛 Markdownlint (0.37.0)
315-315: null
Fenced code blocks should have a language specified(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
(9 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
markdown/docs/tools/cli/usage.md
315-315: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
702-702: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
806-806: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (1)
markdown/docs/tools/cli/usage.md (1)
3-3
: LGTM! Documentation weight adjustment.The weight change from 50 to 40 helps organize the documentation structure.
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3552--asyncapi-website.netlify.app/ |
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
New Features
convert
,optimize
, andvalidate
commands with proxy settingsDocumentation