-
-
Notifications
You must be signed in to change notification settings - Fork 980
docs(community): update latest community documentation #4407
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(community): update latest community documentation #4407
Conversation
WalkthroughEdits to a single documentation file update Restream/encoder wording, rename and replace screenshots, add alt text for accessibility, fix numbering/formatting, revise the title/description guidance, and remove the entire podcasts publication section. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Pre-merge checks (2 passed, 1 inconclusive)❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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.
Please see the documentation for more information. 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 |
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4407 +/- ##
=========================================
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:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4407--asyncapi-website.netlify.app/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 (1)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
84-86: Incomplete sentence — please complete or remove.The line ends with “It is because by” and breaks the flow.
-You must start with YouTube first, even though Restream can directly stream there. It is because by +You must start in YouTube first, even though Restream can stream there directly. This ensures the YouTube event’s metadata (for example, live captions) is configured before linking it in Restream.
🧹 Nitpick comments (2)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)
60-65: Clarify thumbnail guidance and metadata reuse.Add a concrete thumbnail recommendation; also explicitly note that Restream may reuse previous metadata if fields are left blank.
- Add a thumbnail for the stream, as platforms like YouTube require one. + - Add a thumbnail for the stream (e.g., 1280×720, 16:9; under ~2 MB). Some platforms require one.
100-103: Tighten phrasing around the “Live Control Room” icon.Avoid duplicated wording and make the inline icon reference clearer.
-1. Once a new live stream is created, in the list of `Upcoming` streams, click `View in Live Control Room` <img src="../../assets/meetings/yt5.png" width="3%" alt="Live icon" /> icon next to your live stream: +1. Once the live stream is created, in `Upcoming`, click the `View in Live Control Room` icon (<img src="../../assets/meetings/yt5.png" width="3%" alt="Live icon" />) next to your stream:
📜 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: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
🔇 Additional comments (6)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (6)
56-57: Alt text and asset rename look good.
68-81: Good accessibility improvements.Alt text for Zoom steps is clear.
106-107: Closed captions step looks good.Alt text is descriptive.
110-111: LGTM on Studio screenshot and alt text.
116-117: LGTM on edit-title screenshot and alt text.
123-124: LGTM on stream details screenshot and alt text.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typos and product casing in Restream option.
"RMTP" → "RTMP"; add spaces around the pipe and commas; "VMix" → "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 to 53, fix typos and product casing in the Restream option text:
change "RMTP" to "RTMP", add spaces around the pipe character and after commas
so it reads "Encoder | RTMP (Stream from OBS, Zoom, vMix, etc.)", and update
"VMix" to "vMix"; ensure the image alt text/caption reflects the corrected
wording if present.
| <img src="../../assets/meetings/restream6.png" width="40%" alt="Restream: YouTube destination" /> | ||
|
|
||
| 1. Make sure you do not create a new event, but select the one you already created on YouTube, with closed captions on: | ||
|
|
||
| <img src="../../assets/meetings/restream7.png" width="40%" /> | ||
| <img src="../../assets/meetings/restream7.png" width="40%" alt="Restream: Create event" /> | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Align screenshot alt text with instruction to reuse existing event.
The step says “do not create a new event,” but the alt text reads “Create event,” which can mislead.
- <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 (do not create a new one)" />Run to verify all referenced images exist and no “RMTP” typos remain:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
FILE="markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md"
BASE_DIR="$(dirname "$FILE")"
echo "Checking for 'RMTP' typos (should be none after fixes):"
rg -n 'RMTP\b' || true
echo "Verifying image assets referenced in $FILE exist:"
rg -no '\.\./\.\./assets/meetings/[^\)"]+' "$FILE" | while read -r rel; do
path="$BASE_DIR/$rel"
if [[ -f "$path" ]]; then
echo "OK $path"
else
echo "MISS $path"
fi
doneLength of output: 2117
Fix RMTP typo and missing image assets in MEETINGS_ORGANIZATION.md
- At line 50, change “RMTP” to “RTMP” in the encoder option.
- All
../../assets/meetings/*.pngreferences (e.g. stream1.png, zoom1.png, yt1.png, restream6.png, restream7.png, etc.) are missing – add the missing files or correct the paths.
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 127-132 (and specifically line ~50), change the encoder option text
from "RMTP" to "RTMP" to correct the typo; then fix the broken image references
by either placing the missing PNG files into the repository at assets/meetings/
(matching the ../../assets/meetings/*.png names used) or updating the img src
paths in this Markdown to point to the actual location of those images (ensure
relative paths from this file resolve correctly and update every occurrence:
stream1.png, zoom1.png, yt1.png, restream6.png, restream7.png, etc.).
* docs(community): update latest community documentation (#4407) * chore: update meetings.json and newsrooom_videos.json (#4410) * chore: update meetings.json and newsrooom_videos.json (#4405) * chore: update meetings.json, newsrooom_videos.json and dashboard.json * Update meetings.json --------- Co-authored-by: asyncapi-bot <[email protected]> Co-authored-by: Eve <[email protected]> Co-authored-by: Sambhav Gupta <[email protected]> * chore: update meetings.json and newsrooom_videos.json (#4411) * fix: #4065 Made Case Studies page table section mobile responsive (#4403) * fixes #4065. Made Case Studie page mobile responsive * fixes #4065. Made Case Studie page mobile responsive * fix: #4381 --------- Co-authored-by: Sambhav Gupta <[email protected]> * chore(deps): bump axios from 1.8.2 to 1.12.1 (#4413) * chore(deps): bump @babel/runtime and next-language-detector (#4414) * chore: update tools.json (#4417) * chore: update meetings.json and newsrooom_videos.json (#4419) * ci: update of files from global .github repo (#4418) * fix: broken AsyncAPI contributing guidelines link (#4395) (#4398) Co-authored-by: SanidhyaMadheshia <[email protected]> Co-authored-by: Sambhav Gupta <[email protected]> Co-authored-by: V Thulisile Sibanda <[email protected]> --------- Co-authored-by: Chan <[email protected]> Co-authored-by: asyncapi-bot <[email protected]> Co-authored-by: Eve <[email protected]> Co-authored-by: namanjain24-sudo <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: SanidhyaMadheshia <[email protected]> Co-authored-by: SanidhyaMadheshia <[email protected]> Co-authored-by: V Thulisile Sibanda <[email protected]>
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit