Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Sep 10, 2025

Updated community documentation is available and this PR introduces update to community folder on the website

Summary by CodeRabbit

  • Documentation
    • Updated streaming setup instructions and screenshots, including new label text for the encoder option.
    • Revised guidance on titles, descriptions, and thumbnails; clarified description reuse risk and added thumbnail requirement.
    • Improved accessibility with descriptive alt text across images and standardized asset names.
    • Corrected numbering and minor formatting issues.
    • Removed the “Publish broadcasted meetings as podcasts” section and related subsections.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2025

Walkthrough

Edits 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

Cohort / File(s) Summary
Encoder/Restream labeling and assets
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Updated Restream option label to “Encoder
Title/Description step revisions
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Adjusted title line; changed description guidance to avoid reuse of prior stream descriptions; added instruction to include a thumbnail; updated screenshot reference to stream3.png with alt text.
Accessibility (alt text) additions
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Added alt text to images across Zoom, Restream, and YouTube steps (e.g., Live Transcript, Update Titles, Create event, Go Live, captions).
Numbering/formatting fixes
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Corrected list numbering (e.g., -1. to 1.) and minor spacing/formatting cleanups.
Content removal: podcasts section
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Removed the entire “How do I publish broadcasted meetings as podcasts?” section and all its subsections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • thulieblack
  • TRohit20
  • asyncapi-bot-eve

Pre-merge checks (2 passed, 1 inconclusive)

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The current title “docs(community): update latest community documentation” is overly generic and does not highlight the main changes such as renaming restream assets to stream assets, adding alt text and screenshots updates in the meetings guide, or the removal of the podcast section. It fails to convey the specific scope or impact of the PR, making it difficult for reviewers to quickly understand what was modified. As a result, the title lacks clarity and does not serve its purpose of succinctly summarizing the primary change. Please revise the title to accurately reflect the main updates—for example, “docs(community): rename restream assets, add alt text in meetings guide, and remove podcast section”—so that reviewers can immediately grasp the core changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Poem

A bunny taps keys with nimble delight,
Renaming screenshots deep into night.
Alt text sprinkled, numbering neat—
The podcast burrow now discreet.
Streams hop forward, captions in tow,
Docs refreshed—on with the show! 🐇✨

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.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

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
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-community-docs-a132a2e7562e89425bbb7f0422d3da67f387edd4

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify
Copy link

netlify bot commented Sep 10, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit c89c5e1
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/68c1311d240793000888f324
😎 Deploy Preview https://deploy-preview-4407--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 project configuration.

@codecov
Copy link

codecov bot commented Sep 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1991a70) to head (c89c5e1).
⚠️ Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@asyncapi-bot
Copy link
Contributor Author

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 32
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

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

@asyncapi-bot asyncapi-bot merged commit 7f53694 into master Sep 10, 2025
34 of 35 checks passed
@asyncapi-bot asyncapi-bot deleted the update-community-docs-a132a2e7562e89425bbb7f0422d3da67f387edd4 branch September 10, 2025 08:09
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 1991a70 and c89c5e1.

📒 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.

Comment on lines +50 to 53
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"/>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

Suggested change
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.

Comment on lines +127 to 132
<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" />

Copy link
Contributor

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
done

Length 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/*.png references (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.).

sambhavgupta0705 added a commit that referenced this pull request Sep 18, 2025
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants