docs: update MEETINGS_ORGANIZATION document#2035
docs: update MEETINGS_ORGANIZATION document#2035asyncapi-bot merged 6 commits intoasyncapi:masterfrom
Conversation
ezinneanne
requested review from
asyncapi-bot-eve,
bandantonio,
derberg and
thulieblack
as code owners
WalkthroughUpdated Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Suggested reviewers
✨ 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 |
|
@thulieblack do we still need to change the restream images |
|
Yes, @ezinneanne, a lot has changed in the UI. Can you write me a detailed list of the screenshots you need for your doc? |
|
Okay @thulieblack, I will need the 1. the screenshot for setting up multiple stream options such as Zoom, OBS (Encoder| RMTP), 2. Add new channel 3. Provide title and description 4. Stream details 5. Live transcript 6. Enable transcriptions 7. Start with Youtube option I can't access Restream too much as am limited with the free plan but I used the current docs info as well. |
|
@thulieblack I have updated the meetings doc, although the restream first section is still pending as it requires youtube and restream images |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (4)
52-52: Add alt text for accessibility and to satisfy markdownlint MD045.Apply this diff:
- <img src="../../assets/meetings/stream1.png" width="50%" /> + <img src="../../assets/meetings/stream1.png" alt="Restream: choose Encoder | RTMP option" width="50%" />
56-56: Add alt text for accessibility and to satisfy markdownlint MD045.Apply this diff:
- <img src="../../assets/meetings/stream2.png" width="50%" /> + <img src="../../assets/meetings/stream2.png" alt="Restream: Update Titles card" width="50%" />
62-62: Capitalize “YouTube” and tighten phrasing.Minor wording and brand-capitalization fix; LanguageTool flagged this area.
Apply this diff:
- - Add a thumbnail for the stream as platforms like Youtube require one. + - Add a thumbnail for the stream, as some platforms (e.g., YouTube) require one.Optionally, consider adding recommended thumbnail specs (dimensions, ratio, and size) for YouTube; if you want, I can propose exact wording once you confirm the values you want to standardize on.
64-64: Optional refactor: Add descriptive alt text for accessibility (markdownlint MD045)Please update the image at line 64 in
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.mdto include analtattribute:- <img src="../../assets/meetings/stream3.png" width="50%" /> + <img src="../../assets/meetings/stream3.png" alt="Restream: edit stream title and description" width="50%" />
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (3)
assets/meetings/stream1.pngis excluded by!**/*.pngassets/meetings/stream2.pngis excluded by!**/*.pngassets/meetings/stream3.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[grammar] ~60-~60: There might be a mistake here.
Context: ...sponds with the meeting you just started, - Meeting description must be provided eve...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...old one from other streams will be used. - Add a thumbnail for the stream as platfo...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
52-52: Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
64-64: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
50-50: Fix protocol typo and align with Restream UI labeling“RMTP” should be “RTMP”, with a space around the pipe and proper commas, and use the correct brand casing “vMix”. Confirmed the current Restream Help Center uses “Encoder | RTMP”. Apply this diff:
-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:
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[grammar] ~60-~60: There might be a mistake here.
Context: ...sponds with the meeting you just started, - Meeting description must be provided eve...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...old one from other streams will be used. - Add a thumbnail for the stream as platfo...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
52-52: Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
64-64: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
50-50: Update to “Encoder | RTMP” and fix spacing, commas, and casing-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:Confirm this matches the current Restream UI label before merging.
|
/ptal |
|
@derberg @bandantonio @thulieblack Please take a look at this PR. Thanks! 👋 |
|
Aside from coderabbit comments, lgtm |
|
I have added the requested changes @thulieblack @bandantonio |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
84-86: Complete the unfinished sentence explaining “YouTube first.”Replace the incomplete line in docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (around lines 84–86) with:
-You must start with YouTube first, even though Restream can directly stream there. It is because by +You must start with YouTube first, even though Restream can stream there directly. This ensures closed captions are enabled and creates the event you will select later in Restream.
♻️ Duplicate comments (4)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (4)
52-52: Alt text added resolves MD045.Looks good and improves accessibility.
56-56: Alt text added resolves MD045.All good.
60-62: Bullets read well and fix prior grammar issues.Thanks for aligning tone and capitalization.
64-64: Alt text added resolves MD045.✅
🧹 Nitpick comments (5)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (5)
100-103: Minor wording/ordering tweak for clarity.Move “icon” before the inline image and add “the.”
-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 a new live stream is created, in the list of `Upcoming` streams, click the `View in Live Control Room` icon <img src="../../assets/meetings/yt5.png" width="3%" alt="Live icon" /> next to your live stream:
110-111: Capitalize “Studio” in alt text to match UI.Consistency with the button label.
- <img src="../../assets/meetings/restream1.png" width="50%" alt="Restream: Start with studio option" /> + <img src="../../assets/meetings/restream1.png" width="50%" alt="Restream: Start with Studio option" />
120-123: Tighten grammar and align with earlier Zoom-first bullets; add thumbnail note for parity.Makes style consistent across sections and prevents stale descriptions.
- - Title for the live stream that corresponds with the meeting you just started, - - Meeting description must be provided even if the field is empty; otherwise, the old one from other streams will be used. + - Provide a title for the live stream that corresponds to the meeting you just started. + - Always provide a meeting description; otherwise, the previous description from another stream might be reused. + - Add a thumbnail for the stream, as platforms like YouTube require one.
141-141: Use “Log in to” instead of “Login to.”“Log in” is the verb phrase; “login” is a noun/adjective.
-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: Fix typo: “Committee.”Correct spelling for “Technical Steering Committee.”
-... Technical Steering Commitee ... +... Technical Steering Committee ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(2 hunks)
🔇 Additional comments (3)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (3)
68-80: Good: Zoom screenshots converted to Markdown with descriptive alt text.Accessibility and consistency both improved.
52-64: Image asset availability confirmed All images referenced in MEETINGS_ORGANIZATION.md exist underassets/meetings/—no broken images.
50-52: Fix capitalization, typo, and phrasing
Confirmed Restream’s UI reads “Encoder | RTMP.” Update the sentence accordingly:-1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder|RMTP (Stream from OBS,Zoom,VMix,etc.)` option: +1. Log in to [Restream.io](https://app.restream.io/home) and select `Encoder | RTMP (Stream from OBS, Zoom, vMix, etc.)`:
| 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.
💡 Verification agent
❓ Verification inconclusive
Fix broken alt-attribute quoting (HTML parse error) and align alt text with instruction.
The alt attribute is missing a closing quote. Also, the instruction says not to create a new event—consider reflecting that in the alt text.
- <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" />Fix HTML alt attribute quoting and update alt text
- Close the alt attribute with a terminating quote to prevent the HTML parse error.
- Change the alt text to “Restream: Select existing YouTube event” so it reflects using an existing event rather than creating a new one.
(Line 131 in docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md)
🤖 Prompt for AI Agents
In docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md around line 131,
the img tag's alt attribute is missing its closing quote and the alt text is
inaccurate; fix by terminating the alt attribute with a closing double-quote and
update the alt text to "Restream: Select existing YouTube event" so the tag
becomes valid HTML and accurately describes selecting an existing YouTube event.
|
/rtm |
|
Hey @ezinneanne could you open another PR to update the closing quote. The tests are failing asyncapi/website#4404 |
4 participants
Description
Related issue(s)
Resolves #1986Summary by CodeRabbit