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.

Sign up for GitHub

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

Jump to bottom

docs(cli): update latest cli documentation #3458

Merged
merged 1 commit into from
Dec 9, 2024
Merged

docs(cli): update latest cli documentation #3458

merged 1 commit into from
Dec 9, 2024

Conversation

asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Dec 9, 2024 •
edited by coderabbitai bot
Loading

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

Summary by CodeRabbit

  • Documentation
    • Updated usage documentation for the AsyncAPI CLI to reflect the transition from version 2.11.1 to 2.12.0.
    • Revised command output examples and source code links to point to the new version.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Dec 9, 2024 •
edited
Loading

Walkthrough

The changes in this pull request involve updating the usage documentation for the AsyncAPI CLI from version 2.11.1 to 2.12.0. This includes modifications to command output examples and the corresponding source code links to reflect the new version. The structure and content of the documentation remain unchanged, focusing solely on versioning updates.

Changes

File Path Change Summary
markdown/docs/tools/cli/usage.md Updated version from 2.11.1 to 2.12.0 in command outputs and references. All code references updated to point to the new version's file paths.

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • VaishnaviNandakumar
  • devilkiller-ag
  • J0SAL
  • BhaswatiRoy
  • sambhavgupta0705
  • TRohit20
  • asyncapi-bot-eve

🐰 In the garden, hopping free,
Version updates, oh so glee!
From two eleven to twelve point oh,
Documentation shines, ready to show!
With links that guide, and commands so bright,
AsyncAPI CLI, a joyful sight! 🌼

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between da40c06 and 6667cec.

📒 Files selected for processing (1)
  • markdown/docs/tools/cli/usage.md (28 hunks)
✅ Files skipped from review due to trivial changes (1)
  • markdown/docs/tools/cli/usage.md

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 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.

@netlify Netlify
Copy link

netlify bot commented Dec 9, 2024 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 6667cec
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67568877a1e243000851c8c2
😎 Deploy Preview https://deploy-preview-3458--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.

@codecov Codecov
Copy link

codecov bot commented Dec 9, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.18%. Comparing base (da40c06) to head (6667cec).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #3458   +/-   ##
=======================================
  Coverage   70.18%   70.18%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          466      466           
  Misses        198      198

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

@asyncapi-bot
Copy link
Contributor Author

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 32
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3458--asyncapi-website.netlify.app/

@asyncapi-bot asyncapi-bot merged commit cd391cc into master Dec 9, 2024
34 checks passed
@asyncapi-bot asyncapi-bot deleted the update-cli-docs-f61e8ed1c83108bd376f65bf75061eaccc0bbefd branch December 9, 2024 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asyncapi-bot-eve asyncapi-bot-eve asyncapi-bot-eve approved these changes

@quetzalliwrites quetzalliwrites Awaiting requested review from quetzalliwrites quetzalliwrites is a code owner

@devilkiller-ag devilkiller-ag Awaiting requested review from devilkiller-ag

@sambhavgupta0705 sambhavgupta0705 Awaiting requested review from sambhavgupta0705

@BhaswatiRoy BhaswatiRoy Awaiting requested review from BhaswatiRoy

@J0SAL J0SAL Awaiting requested review from J0SAL

@TRohit20 TRohit20 Awaiting requested review from TRohit20

@VaishnaviNandakumar VaishnaviNandakumar Awaiting requested review from VaishnaviNandakumar

Assignees
No one assigned
Labels
autoapproved autoupdate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@asyncapi-bot @asyncapi-bot-eve