Skip to content

fix: replace relative links with absolute links#2072

Merged
asyncapi-bot merged 5 commits intoasyncapi:masterfrom
animeshk923:absolute-img-links
Sep 25, 2025
Merged

fix: replace relative links with absolute links#2072
asyncapi-bot merged 5 commits intoasyncapi:masterfrom
animeshk923:absolute-img-links

Conversation

@animeshk923
Copy link
Contributor

@animeshk923 animeshk923 commented Sep 14, 2025

Description

  • This PR changes the relative image links to absolute ones.

Related issue(s)
Fixes #2068

Summary by CodeRabbit

  • Documentation
    • Updated image references to stable GitHub URLs so illustrations render consistently across platforms.
    • Fixed ordered-list numbering in the YouTube flow for clearer step sequencing.
    • Added a clarifying sentence in the Restream-first section noting YouTube should be started first.
    • No functional or behavioral changes; edits are content and formatting only.

@coderabbitai
Copy link

coderabbitai bot commented Sep 14, 2025

Walkthrough

Converted relative image paths in MEETINGS_ORGANIZATION.md to absolute GitHub blob URLs, fixed the YouTube list numbering from “-1.” to “1.” and added a short sentence in the Restream-first section. Changes are documentation-only; no code/API edits.

Changes

Cohort / File(s) Summary of changes
Docs: image URL updates, list fix, minor text addition
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Replaced relative asset paths (../../assets/meetings/...) with absolute GitHub blob URLs for many images; corrected YouTube flow numbering from “-1.” to “1.”; added an extra (partial) sentence under the Restream-first section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • thulieblack
  • bandantonio
  • asyncapi-bot-eve

Poem

I hop through docs with careful cheer,
Swapping paths so images appear.
One now reads “1.” where it was wrong,
A tiny sentence tagged along.
Carrots crunchy, links now bright—🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes Check ⚠️ Warning Most changes are in-scope link fixes to address [#2068], but the PR also introduces an unrelated incomplete sentence in the "Restream-first" section and a minor list-numbering change; the incomplete sentence is out-of-scope for the linked issue and appears accidental. This stray textual insertion should be addressed before merging. Remove or correct the incomplete sentence and any other non-link documentation edits, and keep this PR focused on the image-link fixes (or move additional documentation changes into a separate follow-up PR).
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "fix: replace relative links with absolute links" succinctly and accurately summarizes the primary change (converting relative image links to absolute URLs) and matches the diff in MEETINGS_ORGANIZATION.md. It is concise, specific, and appropriate for history scanning.
Linked Issues Check ✅ Passed The PR replaces relative image references in MEETINGS_ORGANIZATION.md with absolute raw.githubusercontent.com URLs, directly addressing linked issue [#2068] ("Images are not displaying") and should restore images in the deployed docs. Other edits are limited to a list-numbering tweak and a small textual insertion that does not affect image loading.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fee60b and 7d92f60.

📒 Files selected for processing (1)
  • docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md

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.


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.

@animeshk923
Copy link
Contributor Author

@thulieblack PTAL

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: 4

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)

52-131: Replace GitHub blob image URLs with raw or repository-relative paths (blob links return HTML)
HEAD checks show github.com/.../blob/... → Content-Type: text/html while raw.githubusercontent.com/... → Content-Type: image/png. Update docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (lines 52–131) to use raw.githubusercontent.com or, preferably, repository-relative paths (e.g., assets/meetings/stream1.png) so images serve as image/* in production.

🧹 Nitpick comments (2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)

98-102: Minor: the inline icon width at 3% is tiny.

Consider a fixed pixel width (e.g., 16–24px) or a slightly larger percentage for readability on mobile.


52-131: Optional: prefer first‑party hosting or site‑absolute paths.

If the docs site can serve /assets/meetings/*, use absolute site paths instead of external GitHub hosts. Benefits: better caching, availability, and CSP compliance. Alternatively, pin to a commit SHA in raw.githubusercontent.com to avoid drift.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 57f4c7d and 9fee60b.

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

@thulieblack
Copy link
Member

@bandantonio your review here please

@bandantonio
Copy link
Collaborator

@animeshk923 Please apply all the suggestions from code rabbit, they are valid. Blob URLs are OK to reference source code or certain markdown files located within a repo but not rendered on the website, but images must be in the raw format suggested by code rabbit.

@animeshk923
Copy link
Contributor Author

@animeshk923 Please apply all the suggestions from code rabbit, they are valid. Blob URLs are OK to reference source code or certain markdown files located within a repo but not rendered on the website, but images must be in the raw format suggested by code rabbit.

Understood.

- updated image links with raw.githubusercontent.com links
- applied suggestions from coderabbit
- comment ref: asyncapi#2072 (comment)
@animeshk923
Copy link
Contributor Author

@bandantonio PTAL, I've made the changes required.

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 46ee6b4 into asyncapi:master Sep 25, 2025
10 checks passed
@thulieblack
Copy link
Member

Thank you Animesh

@animeshk923
Copy link
Contributor Author

Thank you Animesh

My pleasure!

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.

Images are not displaying

4 participants