Skip to content

Conversation

@vikasp07
Copy link

@vikasp07 vikasp07 commented Dec 26, 2025

Description

fixes #4818
This pull request fixes a couple of minor typos in the CLI installation documentation to improve clarity and readability.

  • Corrected spelling of "Alternatively"
  • Fixed typo in "pass the version"

This is a documentation-only change and does not affect any functionality.

Summary by CodeRabbit

  • Bug Fixes

    • Corrected spelling errors in CLI installation documentation.
  • Documentation

    • Added instructions for global installation of AsyncAPI CLI via npm, including the installation command.

✏️ Tip: You can customize this high-level summary in your review settings.

@netlify
Copy link

netlify bot commented Dec 26, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4576ab8
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/695a0b7ddb1f9800087402b9
😎 Deploy Preview https://deploy-preview-4785--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 project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 26, 2025

📝 Walkthrough

Walkthrough

Fixed typos ("Alternitavely" → "Alternatively" and "verion" → "version") and added new content in the Using NPM and Node.js section demonstrating how to install AsyncAPI CLI globally via npm.

Changes

Cohort / File(s) Summary
Documentation updates
assets/docs/fragments/cli-installation.md
Fixed two typos in the Using NPM and Node.js section; added new subsection with npm global installation instructions and code example for npm install -g @asyncapi/cli``

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A typo here, a typo there,
"Alternitavely" caught with care!
Now CLI installs with npm shine,
Global paths dance, everything's fine! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately summarizes the primary changes: fixing typos in CLI installation documentation and adding global installation instructions.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Dec 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (18ec38f) to head (4576ab8).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4785   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          798       798           
  Branches       146       146           
=========================================
  Hits           798       798           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 26, 2025

⚡️ Lighthouse report for the changes in this PR:

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

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

@vikasp07 vikasp07 changed the title docs: fix typos in CLI installation documentation docs: fix typos in CLI installation documentation Fixes #4818 Jan 2, 2026
@vikasp07 vikasp07 changed the title docs: fix typos in CLI installation documentation Fixes #4818 docs: fix typos in CLI installation documentation fixes #4818 Jan 2, 2026
@princerajpoot20
Copy link
Member

@TRohit20 PTAL

@princerajpoot20
Copy link
Member

https://github.com/asyncapi/website/actions/runs/20653553533/job/59327722596
The notify-triagers run is failing and needs investigation. Let me create an issue for this.

Also, after the re-run, even though it did not fail, it still did not notify the docs triagers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs Bug 🐞 report]: docs: fix typos in CLI installation documentation

3 participants