docs(community): update latest community documentation#4404
docs(community): update latest community documentation#4404asyncapi-bot wants to merge 1 commit intomasterfrom
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
thulieblack
as code owners
❌ Deploy Preview for asyncapi-website failed.
|
WalkthroughDocumentation for organizing meetings and live streaming was updated: revised Zoom/Restream/YouTube steps, replaced/renamed images with alt text, restructured “Provide title and description,” reordered Restream-first guidance, added post-meeting steps, and removed podcast publication content. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Host
participant Zoom
participant Restream
participant YouTube
Note over Host,YouTube: Zoom-first streaming flow
Host->>Zoom: Start meeting and enable live streaming
Zoom->>Restream: Stream via Encoder/RTMP
Restream->>YouTube: Forward stream to channel
Host->>YouTube: Set title, description, thumbnail
YouTube-->>Host: Live Control Room & captions
Note right of YouTube: Post-meeting: end stream and finalize
%% Style notes
rect rgba(227, 242, 253, 0.4)
Note over Zoom,Restream: Encoder/RTMP option name updated
end
sequenceDiagram
autonumber
actor Host
participant Restream
participant Zoom
participant YouTube
Note over Host,YouTube: Restream-first streaming flow
Host->>YouTube: Create event (Go Live) first
Host->>Restream: Configure destinations incl. YouTube
Restream->>Zoom: Provide RTMP info for Zoom
Host->>Zoom: Start meeting, stream to custom RTMP
Zoom->>Restream: Send stream
Restream->>YouTube: Distribute stream
YouTube-->>Host: Monitor, enable captions
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Pre-merge checks (1 passed, 2 inconclusive)❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4404 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)
84-86: Complete the unfinished sentence explaining why YouTube must be first.The paragraph ends abruptly (“It is because by”). Suggest a concise rationale.
Apply:
-You must start with YouTube first, even though Restream can directly stream there. It is because by -This is what you need to do to kick it off: +You must start with YouTube first, even though Restream can stream directly to YouTube. This ensures you can enable Closed Captions and set event metadata on YouTube; then select this event in Restream (do not create a new one). + +This is what you need to do to kick it off:
50-132: Add missing image assets referenced in MEETINGS_ORGANIZATION.md
All 18 images undermarkdown/docs/community/assets/meetings/referenced inmarkdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.mdare missing and will break the documentation. Add these files at the referenced paths.
🧹 Nitpick comments (3)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (3)
60-65: Add thumbnail guidance (size/aspect) to reduce guesswork.Consider:
- Add a thumbnail for the stream, as platforms like YouTube require one. + - Use a 16:9 thumbnail (for example, 1280×720) for best results.
139-141: “Log in” vs “Login”.Use verb form.
-1. Login to YouTube and add the recorded live stream to the respective YouTube Playlist. +1. Log in to YouTube and add the recorded live stream to the respective YouTube Playlist.
167-167: Spelling: “Committee”.-... Technical Steering Commitee ... +... Technical Steering Committee ...
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(2 hunks)
⏰ 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). (3)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (2)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)
56-57: LGTM: clearer “Update Titles” illustration with alt text.
68-81: Alt text and image swaps improve accessibility and clarity.The updated images + descriptive alt text across Zoom/YouTube/Restream steps look good.
Also applies to: 90-99, 100-103, 106-111, 116-128
| 1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder|RMTP (Stream from OBS,Zoom,VMix,etc.)` option: | ||
|
|
||
| <img src="../../assets/meetings/restream1.png" width="50%" /> | ||
| <img src="../../assets/meetings/stream1.png" width="50%" alt="Restream: Encoder | RTMP option selected"/> | ||
|
|
There was a problem hiding this comment.
Fix RTMP label, spacing, and brand casing in Restream step.
Typo and minor formatting: “RMTP” → “RTMP”, add spaces around “|” and commas, and use “vMix”.
Apply:
-1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder|RMTP (Stream from OBS,Zoom,VMix,etc.)` option:
+1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder | RTMP (Stream from OBS, Zoom, vMix, etc.)` option:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder|RMTP (Stream from OBS,Zoom,VMix,etc.)` option: | |
| <img src="../../assets/meetings/restream1.png" width="50%" /> | |
| <img src="../../assets/meetings/stream1.png" width="50%" alt="Restream: Encoder | RTMP option selected"/> | |
| 1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder | RTMP (Stream from OBS, Zoom, vMix, etc.)` option: | |
| <img src="../../assets/meetings/stream1.png" width="50%" alt="Restream: Encoder | RTMP option selected"/> |
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 50–53, fix the typo and formatting in the Restream step: change
"RMTP" to "RTMP", add spaces around the pipe so it reads "Encoder | RTMP", add
spaces after commas and before "etc.", and use the correct brand casing "vMix"
(e.g., "Encoder | RTMP (Stream from OBS, Zoom, vMix, etc.)"); update the inline
text and any corresponding alt text if it contains the same mistakes.
| <img src="../../assets/meetings/restream7.png" width="40%" alt="Restream: Create event /> | ||
|
|
There was a problem hiding this comment.
Fix malformed tag and align alt text with guidance.
Unclosed quote in alt attribute; also alt suggests creating a new event, which contradicts the instructions.
Apply:
- <img src="../../assets/meetings/restream7.png" width="40%" alt="Restream: Create event />
+ <img src="../../assets/meetings/restream7.png" width="40%" alt="Restream: Select existing YouTube event" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img src="../../assets/meetings/restream7.png" width="40%" alt="Restream: Create event /> | |
| <img src="../../assets/meetings/restream7.png" width="40%" alt="Restream: Select existing YouTube event" /> |
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 131-132, the <img> tag is malformed (missing closing quote and
closing bracket) and the alt text contradicts the instructions; fix the tag by
closing the src/alt attribute quotes and the tag itself (e.g., ...
alt="Restream: Events page" />), and change the alt text to a neutral, accurate
description such as "Restream: Events page" (or another text that matches the
guidance) so the image is well-formed and the alt copy aligns with the document
intent.
3 participants
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit