[AceTheCreator]

Add websocket implementation docs to readme

Summary by CodeRabbit

• Documentation
  • Added guidance on the default WebSocket plugin, including automatic playground enablement for specifications using ws or wss servers.
  • Documented installation and registration requirements when using the React component.
  • Added links to the plugin system documentation and a new “Default plugins” section.

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Run configuration

• Source mode: Auto
• Repository: asyncapi/asyncapi-react
• Branch: master
• File: .coderabbit.yaml
• Commit: 5592882
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: e1e20c9c-0422-4923-ac73-c71fb318b7d8

Commits

Reviewing files that changed from the base of the PR and between 99421fe and 734bfd5.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

No actionable comments were generated in the recent review.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: asyncapi/asyncapi-react/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: a0f892e9-7f44-4f75-a094-790c9e247b9e

📥 Commits

Reviewing files that changed from the base of the PR and between 7b6772f and e451813.

📒 Files selected for processing (2)

• README.md
• docs/README.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.

Walkthrough

The documentation adds Plugin System navigation and describes the default WebSocket plugin. It explains automatic playground enablement, package installation, React component registration, and persistent plugin creation.

Changes: Plugin documentation

Layer / File(s)	Summary
Document plugin usage README.md, docs/README.md	The documentation adds Plugin System navigation and a Default plugins section. It describes asyncapi-ws-plugin, automatic playground enablement for ws and wss servers, installation, and registration through the component's plugins prop.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: Minimal · previous review e4518

This documentation-only change presents no actionable merge-blocking risk and is ready to merge.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately identifies the documentation change for the WebSocket plugin. It is concise and related to the main change.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches: 💡 1

🧪 Generate unit tests (beta)

• Create a new PR

🛠️ Fix failing CI checks: 💡

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud