asyncapi / website

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

docs(tutorials): fix indentation for slackbot with websocket doc #3420

Open bandantonio opened 4 days ago

bandantonio commented 4 days ago

Related issue(s)

Fixes #3418

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

Walkthrough

The changes made in this pull request involve updates to the AsyncAPI document for a Slackbot that uses the WebSocket protocol. Key modifications include correcting the indentation of properties within the hello schema and restructuring the reaction schema for improved clarity. Additionally, refinements were made to the tutorial content to enhance clarity while maintaining the instructional flow.

Changes

File Path Change Summary
markdown/docs/tutorials/websocket/index.md Updated hello schema indentation for app_id and num_connections; restructured reaction schema for clarity and consistent indentation of properties. Refined tutorial content for clarity.

Assessment against linked issues

Objective Addressed Explanation
Correct indentation for reaction schema (3418) βœ…
Correct indentation for app_id property (3418) βœ…

Poem

In the land of code where rabbits play,
Indentations fixed, hip-hip-hooray!
With schemas clear and tutorials bright,
Our Slackbot hops with pure delight! πŸ‡βœ¨
So let’s celebrate this coding spree,
A joyful dance in the land of API!


πŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 1be4431b35c4cd0bb60db948c7b82b43dc1e5f58 and 537947aefa9ca98290093cfbfece6cbc8d7a21a0.
πŸ“’ Files selected for processing (1) * `markdown/docs/tutorials/websocket/index.md` (2 hunks)
πŸ”‡ Additional comments (2)
markdown/docs/tutorials/websocket/index.md (2) `113-113`: **LGTM: Indentation fixes in the `hello` schema look correct!** The indentation has been properly adjusted for: - The `type` property under `app_id` - The `num_connections` property under the root properties object These changes align with the standard YAML indentation pattern and fix the issues mentioned in #3418. Also applies to: 115-115 --- `127-151`: **LGTM: The `reaction` schema structure has been properly reorganized!** The schema now has: - Correct indentation levels for all properties - Clear hierarchical structure - Consistent formatting with the rest of the document - Proper alignment with the complete example shown at the end of the tutorial These changes successfully address the indentation issue mentioned in #3418.

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://docs.coderabbit.ai) 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 days ago

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
Latest commit 537947aefa9ca98290093cfbfece6cbc8d7a21a0
Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/673eead7f1b28300085befd1
Deploy Preview https://deploy-preview-3420--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 days ago

Codecov Report

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

Project coverage is 67.77%. Comparing base (1be4431) to head (537947a).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3420 +/- ## ======================================= Coverage 67.77% 67.77% ======================================= Files 21 21 Lines 664 664 ======================================= Hits 450 450 Misses 214 214 ```

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


🚨 Try these New Features:

asyncapi-bot commented 4 days ago
⚑️ Lighthouse report for the changes in this PR: Category Score
πŸ”΄ Performance 46
🟒 Accessibility 98
🟒 Best practices 92
🟒 SEO 100
πŸ”΄ PWA 33

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