Skip to content
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 #3713

Merged

Conversation

asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Feb 19, 2025

Updated cli documentation is available and this PR introduces update to cli folder on the website

Summary by CodeRabbit

  • Documentation
    • Enhanced CLI usage documentation with clearer headers and consistent formatting for command listings.
    • Updated example command formats to reflect recent changes in interactive mode usage and version specification.

Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

This update revises the CLI usage documentation in markdown/docs/tools/cli/usage.md. It explicitly adds headers for the "Usage" and "Commands" sections and reformats the command list items by replacing asterisks with hyphens. Additionally, the example for the asyncapi generate fromTemplate command is updated to include a version identifier and an interactive flag, clarifying the new usage pattern without affecting underlying functionality.

Changes

File Change Summary
markdown/.../usage.md - Added explicit headers for "Usage" and "Commands" sections.
- Reformatted command list items from asterisks to hyphens.
- Updated asyncapi command example with version (@3.0.0) and --use-new-generator flag.

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • VaishnaviNandakumar
  • Aahil13
  • TRohit20
  • asyncapi-bot-eve

Poem

I'm a rabbit with a joyful hop,
Dancing through lines of text non-stop.
Headers bloom like carrots in spring,
Hyphens march in tidy string.
With every flag and version new,
I celebrate these changes with a cheerful "woo!"
Happy hops to our updated CLI crew!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e288c1a and bf5639e.

📒 Files selected for processing (1)
  • markdown/docs/tools/cli/usage.md (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • markdown/docs/tools/cli/usage.md
⏰ Context from checks skipped due to timeout of 180000ms (2)
  • GitHub Check: Automerge PR autoapproved by a bot
  • GitHub Check: Lighthouse CI

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Feb 19, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit bf5639e
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67b61189338f300008205af4
😎 Deploy Preview https://deploy-preview-3713--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e288c1a) to head (bf5639e).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3713   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          732       732           
=========================================
  Hits           732       732           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot asyncapi-bot merged commit 2457f7c into master Feb 19, 2025
33 of 34 checks passed
@asyncapi-bot asyncapi-bot deleted the update-cli-docs-af0c400be58e5ed1a51b189b4c0e5c43a11e756b branch February 19, 2025 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants