search

asyncapi / website

AsyncAPI specification website
https://www.asyncapi.com
Apache License 2.0
526 stars 668 forks source link

docs(concepts): improve writing style #3354

Closed bandantonio closed 3 weeks ago

bandantonio commented 4 weeks ago

Description This PR improves writing style of the documents located in the Concepts section.

Motivation: make writing more consistent and predictable, as well as easier to skim and understand.

Fixes #3374

Summary by CodeRabbit

coderabbitai[bot] commented 4 weeks ago

Walkthrough

The changes across multiple markdown documents focus on enhancing clarity, consistency, and readability of the content related to AsyncAPI concepts. Key terms are emphasized, sentence structures are refined, and descriptions are streamlined to improve the overall flow of information. Specific adjustments include rephrasing definitions, clarifying roles and relationships within Event-Driven Architecture, and ensuring consistent terminology throughout the documents. Diagrams and their descriptions have also been updated for better comprehension.

Changes

File Path Change Summary
markdown/docs/concepts/application.md Rephrased for clarity; emphasized "application" in italics; modified definitions and examples for readability.
markdown/docs/concepts/asyncapi-document/index.md Textual modifications for clarity; adjusted phrases for grammatical consistency and improved readability.
markdown/docs/concepts/channel.md Enhanced clarity and consistency; rephrased definitions and descriptions; emphasized "channel" in italics.
markdown/docs/concepts/consumer.md Clarified descriptions of consumers; emphasized asynchronous behavior; updated diagram descriptions for consistency.
markdown/docs/concepts/index.md Simplified section header and introductory text for clarity.
markdown/docs/concepts/message.md Enhanced clarity and readability; streamlined definitions and descriptions; rephrased comparisons between messages and events.
markdown/docs/concepts/producer.md Improved clarity and consistency; refined definitions and examples; restructured explanations of the publish/subscribe model.
markdown/docs/concepts/protocol.md Enhanced clarity; restructured descriptions of protocols; updated terminology for formality.
markdown/docs/concepts/server.md Clarified server roles and interactions; emphasized messaging broker functions; improved descriptions of architecture.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

🐰 In the garden where knowledge grows,
Clarity blooms, and understanding flows.
With words refined and meanings clear,
We hop along, spreading cheer!
Through channels and messages, we play,
In the world of AsyncAPI, we find our way! 🌼

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 4 weeks ago

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
Latest commit a13e3ce1ce8cb8e2d6a86f2ab7f2d19e21408028
Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/672bdfb290b284000845af8e
Deploy Preview https://deploy-preview-3354--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[bot] commented 4 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 49.14%. Comparing base (2fb1634) to head (a13e3ce). Report is 1 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3354 +/- ## ======================================= Coverage 49.14% 49.14% ======================================= Files 21 21 Lines 647 647 ======================================= Hits 318 318 Misses 329 329 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

asyncapi-bot commented 4 weeks ago
⚡️ Lighthouse report for the changes in this PR: Category Score
🔴 Performance 44
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

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

akshatnema commented 4 weeks ago

@bandantonio Are these changes made in consideration with @quetzalliwrites? I don't find any concerned issue linked with this PR.

bandantonio commented 3 weeks ago

@akshatnema Sure, this was discussed with @quetzalliwrites some time ago. I pinged her again, so we could probably create an 'epic' issue for that so I can take care of all the related styling aspects across the docs.

quetzalliwrites commented 3 weeks ago

Hola @akshatnema, thanks for looping me in! 😸 Yes, the good news it that Anthony had already talked to me about his suggestions offline. (I still need to review this PR and see if I agree tehehe)

Ah, @bandantonio, to Akshat's point, would you mind creating a new docs issue for your proposal to link to this PR? He makes a good point that a change proposed like this one needs a docs issue.