Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

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

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

Summary by CodeRabbit

  • Documentation
    • Updated onboarding guide to link to the local CONTRIBUTING page for consistent navigation within the docs.
    • Replaced meeting and communication doc images with GitHub-hosted URLs to improve reliability and rendering across environments.
    • Applied minor formatting adjustments to maintain clarity.

@netlify
Copy link

netlify bot commented Sep 25, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 816464d
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/68d51e306b1d0a000848e43b
😎 Deploy Preview https://deploy-preview-4432--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 25, 2025

Walkthrough

Documentation-only updates: one onboarding page switches an external GitHub link to a local CONTRIBUTING.md, and the meetings/communication guide replaces relative image paths with absolute raw GitHub URLs. No code or logic changes.

Changes

Cohort / File(s) Summary
Onboarding link update
markdown/docs/community/000-onboarding/index.md
Replace external GitHub URL with relative link to local CONTRIBUTING.md.
Meetings assets URL update
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Update multiple image sources from local relative paths to absolute raw.githubusercontent.com URLs; one line changes from image tag to URL with same alt text.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • thulieblack
  • TRohit20
  • bandantonio
  • CBID2
  • asyncapi-bot-eve

Poem

I nudge the links with twitchy grace,
From far-off fields to local place.
I hop through streams and Zoomy scenes,
With raw URLs and tidy means.
Docs refreshed, my whiskers gleam—
One small hop for a bunny’s dream. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “docs(community): update latest community documentation” correctly indicates that community documentation was modified but is overly broad and does not convey the specific link and image URL updates introduced in this changeset. Consider using a more descriptive title such as “docs(community): update CONTRIBUTING link and switch community image URLs to raw GitHub paths” to clearly summarize the primary 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.
✨ 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-46ee6b49b58439fe06f8105c957fe0e92a3eb2fa

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.

@codecov
Copy link

codecov bot commented Sep 25, 2025

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4432   +/-   ##
=========================================
  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 37
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

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

@asyncapi-bot asyncapi-bot merged commit 9a8c037 into master Sep 25, 2025
37 of 38 checks passed
@asyncapi-bot asyncapi-bot deleted the update-community-docs-46ee6b49b58439fe06f8105c957fe0e92a3eb2fa branch September 25, 2025 10:54
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: 1

🧹 Nitpick comments (3)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (3)

52-132: Avoid mutable ‘master’ raw URLs; pin images to a commit SHA or use a CDN.

Linking to raw.githubusercontent.com on master risks silent drift/breakage. Prefer:

This stabilizes the docs and improves cacheability.

To identify the current commit to pin, you can fetch the image’s latest commit SHA and update links accordingly.


68-81: Minor: unify image syntax for consistency.

Mixed HTML and Markdown images make widths inconsistent. Either:

  • Use Markdown consistently (accept default sizing), or
  • Use HTML consistently with explicit widths.

Optional, stylistic only.


52-132: Allowlisting remote image domains; optimization not configured

  • next.config.mjs lacks an images.domains or remotePatterns entry—remote <img> tags (e.g., raw.githubusercontent.com) bypass Next.js image optimization. Add images.domains: ['raw.githubusercontent.com'] (or use remotePatterns) or host these assets locally to enable optimization.
  • netlify.toml defines no Content-Security-Policy header—external images load unrestricted. When you introduce CSP, include raw.githubusercontent.com in your img-src directive.
📜 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 54b7241 and 816464d.

📒 Files selected for processing (2)
  • markdown/docs/community/000-onboarding/index.md (1 hunks)
  • markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-11-13T20:34:18.998Z
Learnt from: bandantonio
PR: asyncapi/website#3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).

Applied to files:

  • markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
⏰ 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: Lighthouse CI
  • GitHub Check: Test NodeJS PR - windows-latest

The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively.

> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md).
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 | 🔴 Critical

🧩 Analysis chain

Verify CONTRIBUTING.md path; current relative link likely off by one directory.

From markdown/docs/community/000-onboarding/index.md, ../../CONTRIBUTING.md resolves to markdown/docs/CONTRIBUTING.md. If CONTRIBUTING.md is at repo root or elsewhere, this link will 404. Please confirm location and adjust (e.g., ../../../CONTRIBUTING.md or an absolute site path) accordingly.

Run to locate the correct path and preview all inbound links to CONTRIBUTING.md:


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Finding CONTRIBUTING files:"
fd -i 'contributing.md|CONTRIBUTING.md' -t f

echo
echo "Show current link usage in onboarding file:"
nl -ba markdown/docs/community/000-onboarding/index.md | sed -n '1,120p' | rg -n 'CONTRIBUTING\.md' -n -n -N

echo
echo "Check for a site-level Contributing page that might be preferable:"
rg -n -C2 -i 'contributing' --type md markdown | head -n 100

Length of output: 129


Fix CONTRIBUTING.md link (markdown/docs/community/000-onboarding/index.md:9)
../../CONTRIBUTING.md resolves to markdown/docs/CONTRIBUTING.md (404); update to link the root CONTRIBUTING.md, e.g. /CONTRIBUTING.md or the correct relative path (../../../../CONTRIBUTING.md).

🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/index.md around line 9, the
CONTRIBUTING.md link currently uses ../../CONTRIBUTING.md which resolves to
markdown/docs/CONTRIBUTING.md (404); update the link to point to the repository
root CONTRIBUTING.md (use /CONTRIBUTING.md) or correct the relative path
(../../../../CONTRIBUTING.md) so the link resolves to the root CONTRIBUTING.md.

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