Skip to content

Conversation

@nandini9june-dev
Copy link

@nandini9june-dev nandini9june-dev commented Jan 13, 2026

Description

  • ...
  • ...
  • ...

Related issue(s)

Summary by CodeRabbit

  • Documentation
    • Fixed spelling errors in CLI installation guide.
    • Enhanced global CLI installation instructions with clearer guidance and code examples.

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

@netlify
Copy link

netlify bot commented Jan 13, 2026

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 3cff284
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/69667290bc0cc70008fa5594
😎 Deploy Preview https://deploy-preview-4942--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.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Jan 13, 2026

We require all PRs to follow Conventional Commits specification.
More details 👇🏼

 No release type found in pull request title "fixed typos in cli-installation.md#4818". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 13, 2026

📝 Walkthrough

Walkthrough

Documentation corrections in the CLI installation guide: fixed typos ("Alternitavely" → "Alternatively", "verion" → "version") and expanded the "Install CLI globally" section with descriptive text and a code example for the npm install command.

Changes

Cohort / File(s) Summary
Documentation corrections
assets/docs/fragments/cli-installation.md
Fixed spelling errors (2× "Alternitavely", 2× "verion") and added descriptive text with code block example under "Install CLI globally" section

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A typo here, a typo there,
Spelling fixed with utmost care!
"Alternatly" now stands pristine,
Clear instructions, crisp and clean!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: fixing typos in cli-installation.md as indicated by the file name and issue reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0cf7697 and 3cff284.

📒 Files selected for processing (1)
  • assets/docs/fragments/cli-installation.md
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: Redirect rules - asyncapi-website
  • GitHub Check: Header rules - asyncapi-website
  • GitHub Check: Pages changed - asyncapi-website
  • GitHub Check: Test NodeJS PR - windows-latest
  • GitHub Check: Lighthouse CI
🔇 Additional comments (3)
assets/docs/fragments/cli-installation.md (3)

51-51: LGTM! Typo corrected.

The spelling correction from "Alternitavely" to "Alternatively" is accurate and improves the documentation.


56-60: LGTM! Excellent documentation enhancement.

The added descriptive text and code example make the global installation instructions clearer and more user-friendly. The npm command is correct and the formatting is consistent with the rest of the document.


66-66: LGTM! Typo corrected.

The spelling correction from "verion" to "version" is accurate and improves the documentation.


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 Jan 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (0cf7697) to head (3cff284).

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

☔ 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

⚡️ Lighthouse report for the changes in this PR:

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

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

Copy link
Contributor

@Sourya07 Sourya07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for improving the documentation.
Please make sure to raise an issue first and get it approved before opening any PR.

@nandini9june-dev
Copy link
Author

Thanks for improving the documentation. Please make sure to raise an issue first and get it approved before opening any PR.

Actually,this issue was labelled under "good first issue" and when I checked the application for the changes , it was simply not shown.

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.

3 participants