Skip to content

docs: missing closing quote in image alt attribute#2067

Merged
asyncapi-bot merged 1 commit intoasyncapi:masterfrom
bandantonio:docs/fix-unclosed-quote
Sep 10, 2025
Merged

docs: missing closing quote in image alt attribute#2067
asyncapi-bot merged 1 commit intoasyncapi:masterfrom
bandantonio:docs/fix-unclosed-quote

Conversation

@bandantonio
Copy link
Collaborator

@bandantonio bandantonio commented Sep 9, 2025

Description

Fixed missing closing quote that fails website build for documentation

Related issue(s)
Related to #2035
See also asyncapi/website#4404

Summary by CodeRabbit

  • Documentation
    • Corrected HTML syntax in the Meeting Organization documentation, fixing an incomplete alt attribute for an image in the Restream-first section.
    • The alt text is now properly quoted and the tag closed, improving accessibility and preventing potential rendering issues in some viewers.
    • No content changes; this is a formatting fix only.

@coderabbitai
Copy link

coderabbitai bot commented Sep 9, 2025

Walkthrough

Corrected an HTML attribute in docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md by fixing an incomplete alt value in an image tag within the Restream-first section. No other content or code changes.

Changes

Cohort / File(s) Summary of Changes
Docs HTML fix
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Fixed malformed image alt attribute: alt="Restream: Create event />alt="Restream: Create event" />.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • thulieblack
  • asyncapi-bot-eve

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title “docs: missing closing quote in image alt attribute” accurately and succinctly describes the specific HTML syntax fix in the documentation, directly reflecting the main change in the pull request without introducing extraneous detail.
Description Check ✅ Passed The description clearly states that a missing closing quote causing the website build to fail has been fixed and appropriately references the related issue and companion PR, making it directly relevant to the changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Poem

A nibble of quotes, a tag set right,
I twitch my whiskers—syntax light.
Alt now closed, the pixels gleam,
A tidy doc, a coder’s dream.
Hop-hop hooray, the markup sings! 🐇✨

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.

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

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.

@bandantonio
Copy link
Collaborator Author

@thulieblack Fix for asyncapi/website#4404

Copy link

@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: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)

50-52: Typo: RMTP → RTMP (and minor formatting).
Protocol is RTMP. Also add spacing around commas and correct “vMix” casing for consistency with Line 52.

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:

167-167: Spelling: “Commitee” → “Committee”.
User-facing docs; fix the typo.

Apply this diff:

-... Technical Steering Commitee ...
+... Technical Steering Committee ...
🧹 Nitpick comments (2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)

140-141: Grammar nit: “Login” (noun) vs “Log in” (verb).
Use “Log in to YouTube…”.

Apply this diff:

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

1-5: Add a docs linter to prevent regressions like unclosed quotes.
Consider enabling remark-lint/markdownlint and an HTML validator (e.g., HTMLProofer in CI) to catch malformed HTML in Markdown.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c33f20 and 924e431.

📒 Files selected for processing (1)
  • docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1 hunks)
🔇 Additional comments (2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)

131-131: Fix is correct — closes the alt quote and unblocks the docs build.
Alt text now properly quoted and the img tag is valid HTML.


84-86: Incomplete sentence — please finish the thought.
The line ends with “It is because by ” and doesn’t explain the reason.

Suggested wording (adjust as needed based on actual process): “You must start with YouTube first, even though Restream can stream there directly, because live captions must be enabled on the YouTube event and then selected in Restream.”

Copy link
Member

@thulieblack thulieblack left a comment

Choose a reason for hiding this comment

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

Thanks Anthony

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit a132a2e into asyncapi:master Sep 10, 2025
22 checks passed
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