fix(docs): consistency in AsyncAPI documentation #3707

Recxsmacx · 2025-02-18T14:30:30Z

Make AsyncAPI documentation more consistent by standardizing formatting and word usage.

Application.md
- Change "micro-service" to "microservice".
Adding-messages.md
- Capitalize "components" to "Components".
Adding-operations.md
- Capitalize "operations" to "Operations".
Define-payload.md
- Remove unnecessary blank lines.
Extending-specification.md
- Capitalize "Specification extensions" to "Specification Extensions".
Reusability-with-traits.md
- Capitalize "traits" to "Traits".

Summary by CodeRabbit

Documentation
- Corrected grammatical issues and standardized terminology (e.g., "microservice," "Components," "Operations," and "Specification Extensions") for improved clarity.
- Updated headings and titles for consistent presentation.
- Enhanced guidelines with detailed examples for defining payload schemas and specifying schema formats (including Avro and Protobuf).

Fixes #3385 Make AsyncAPI documentation more consistent by standardizing formatting and word usage. * **Application.md** - Change "micro-service" to "microservice". * **Adding-messages.md** - Capitalize "components" to "Components". * **Adding-operations.md** - Capitalize "operations" to "Operations". * **Define-payload.md** - Remove unnecessary blank lines. * **Extending-specification.md** - Capitalize "Specification extensions" to "Specification Extensions". * **Reusability-with-traits.md** - Capitalize "traits" to "Traits".

netlify · 2025-02-18T14:30:48Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`cf3a450`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67b49989ed0b1c0008b0f529
😎 Deploy Preview	https://deploy-preview-3707--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle 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 · 2025-02-18T14:32:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b1c7f7c) to head (cf3a450).
Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3707   +/-   ##
=========================================
  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.

coderabbitai · 2025-02-18T14:39:12Z

Walkthrough

The changes consist of minor updates to AsyncAPI documentation files. Grammar corrections, capitalization adjustments, and a few content enhancements have been applied to improve consistency and clarity. One document now includes expanded explanations and examples for payload schemas, while other files received minor stylistic fixes without altering their underlying logic.

Changes

File(s)	Change Summary
`markdown/docs/concepts/application.md`	Corrected terminology by replacing “micro-service” with “microservice” and added a newline at the end of the document.
`markdown/docs/concepts/asyncapi-document/adding-messages.md`, `adding-operations.md`, `extending-specification.md`, `reusability-with-traits.md`	Adjusted capitalization for consistency (e.g., “components” to “Components”, “operations” to “Operations”, title capitalizations in Specification and Traits).
`markdown/docs/concepts/asyncapi-document/define-payload.md`	Added detailed explanations and examples for defining payload schemas, including inline, component, remote, and local file references, plus clarifications on schema formats.

Suggested labels

ready-to-merge, autoapproved

Suggested reviewers

quetzalliwrites
VaishnaviNandakumar
Aahil13
asyncapi-bot-eve
TRohit20
devilkiller-ag

Poem

I'm a rabbit of the docs, hopping with glee,
Tiny tweaks and fixes make the pages sing free.
Capital letters and proofs, lined up just right,
Payloads and schemas now shine bright.
With every small change, I dance with delight!
Hoppin' through the docs all day and night.
Cheers to updates that make our docs feel light!

📜 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 b1c7f7c and cf3a450.

📒 Files selected for processing (6)

markdown/docs/concepts/application.md (2 hunks)
markdown/docs/concepts/asyncapi-document/adding-messages.md (1 hunks)
markdown/docs/concepts/asyncapi-document/adding-operations.md (2 hunks)
markdown/docs/concepts/asyncapi-document/define-payload.md (0 hunks)
markdown/docs/concepts/asyncapi-document/extending-specification.md (1 hunks)
markdown/docs/concepts/asyncapi-document/reusability-with-traits.md (1 hunks)

💤 Files with no reviewable changes (1)

markdown/docs/concepts/asyncapi-document/define-payload.md

✅ Files skipped from review due to trivial changes (5)

markdown/docs/concepts/asyncapi-document/extending-specification.md
markdown/docs/concepts/application.md
markdown/docs/concepts/asyncapi-document/reusability-with-traits.md
markdown/docs/concepts/asyncapi-document/adding-messages.md
markdown/docs/concepts/asyncapi-document/adding-operations.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 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.

vishvamsinh28 · 2025-02-18T14:39:39Z

@Recxsmacx fix the lint error by changing the title, add proper prefix to it

Recxsmacx · 2025-02-18T14:40:11Z

done @vishvamsinh28

anshgoyalevil · 2025-02-23T13:04:42Z

I would prefer going ahead with #3386 which has better code changes and was opened earlier

Recxsmacx requested review from TRohit20, asyncapi-bot-eve and quetzalliwrites as code owners February 18, 2025 14:30

asyncapi-bot requested review from Aahil13 and VaishnaviNandakumar February 18, 2025 14:30

Recxsmacx changed the title ~~Fix docs consistency in AsyncAPI documentation~~ fix docs consistency in AsyncAPI documentation Feb 18, 2025

Recxsmacx closed this Feb 18, 2025

Recxsmacx reopened this Feb 18, 2025

Recxsmacx changed the title ~~fix docs consistency in AsyncAPI documentation~~ fix(docs): consistency in AsyncAPI documentation Feb 18, 2025

anshgoyalevil closed this Feb 23, 2025

coderabbitai bot mentioned this pull request Mar 9, 2025

fix: broken link in reusability traits page in docs #3769

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(docs): consistency in AsyncAPI documentation #3707

fix(docs): consistency in AsyncAPI documentation #3707

Uh oh!

Recxsmacx commented Feb 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Feb 18, 2025 •

edited

Loading

Uh oh!

codecov bot commented Feb 18, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Feb 18, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

vishvamsinh28 commented Feb 18, 2025 •

edited

Loading

Uh oh!

Recxsmacx commented Feb 18, 2025

Uh oh!

anshgoyalevil commented Feb 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

fix(docs): consistency in AsyncAPI documentation #3707

fix(docs): consistency in AsyncAPI documentation #3707

Uh oh!

Conversation

Recxsmacx commented Feb 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

netlify bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for asyncapi-website ready!

Uh oh!

codecov bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

vishvamsinh28 commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Recxsmacx commented Feb 18, 2025

Uh oh!

anshgoyalevil commented Feb 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Recxsmacx commented Feb 18, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Feb 18, 2025 •

edited

Loading

codecov bot commented Feb 18, 2025 •

edited

Loading

coderabbitai bot commented Feb 18, 2025 •

edited

Loading

vishvamsinh28 commented Feb 18, 2025 •

edited

Loading