Skip to content

docs: fix broken links in Community README#2222

Merged
asyncapi-bot merged 7 commits intoasyncapi:masterfrom
Harsh16gupta:fix-all-the-broken-readme-links
Jan 27, 2026
Merged

docs: fix broken links in Community README#2222
asyncapi-bot merged 7 commits intoasyncapi:masterfrom
Harsh16gupta:fix-all-the-broken-readme-links

Conversation

@Harsh16gupta
Copy link
Contributor

@Harsh16gupta Harsh16gupta commented Jan 7, 2026

This PR fixes broken and incorrect links in the Community README by updating them to point to existing files within the repository.

Scope:

  • Fixed only broken links
  • No content migration
  • No website URLs added

Fixes #2202

Summary by CodeRabbit

Documentation

  • Updated internal documentation links for Community Goals, Contribution Onboarding, Style Guide, and Governance references to align with current documentation structure.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 7, 2026

📝 Walkthrough

Walkthrough

Updates broken documentation links in README.md to point to correct file paths within the docs directory structure, fixing navigation issues for community contributors accessing governance, onboarding, style guide, and community goals resources.

Changes

Cohort / File(s) Change Summary
Documentation Link Corrections
README.md
Updated 5 broken or incorrect documentation links: Community Goals (→ docs/030-project-vision-strategy-goals/2026_Community_Goals.md), Onboarding Docs (→ docs/000-onboarding/docs-onboarding-checklist.md), Style Guide (→ docs/011-styleguide/aboutguide.md), Governance (→ docs/020-governance-and-policies/GOVERNANCE.md), and Charter (→ docs/020-governance-and-policies/CHARTER.md).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through docs with glee,
Old broken links no more shall be!
Five paths corrected, straight and true,
Contributors now know just where to go—whoosh! 🎯

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix broken links in Community README' directly and accurately describes the main change in the pull request, which updates links in the README.md file.
Linked Issues check ✅ Passed The PR successfully addresses all broken links identified in issue #2202: ./annual-goals, docs/onboarding-guide, docs/styleguide, and governance-related links are all corrected to valid repository paths.
Out of Scope Changes check ✅ Passed All changes are scoped to fixing broken links in README.md as specified in issue #2202; no unrelated modifications or content migrations are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe04738 and f74a0de.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
Repo: asyncapi/community PR: 1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
📚 Learning: 2025-04-29T11:49:47.903Z
Learnt from: thulieblack
Repo: asyncapi/community PR: 1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.

Applied to files:

  • README.md
🔇 Additional comments (1)
README.md (1)

14-14: All documentation link targets have been verified to exist in the repository. The paths are correct for the current repository structure.

  • ✓ Community Goals: docs/030-project-vision-strategy-goals/2026_Community_Goals.md
  • ✓ Contribution Onboarding: docs/000-onboarding/docs-onboarding-checklist.md
  • ✓ Style Guide: docs/011-styleguide/aboutguide.md
  • ✓ Community Governance: docs/020-governance-and-policies/GOVERNANCE.md
  • ✓ AsyncAPI Charter: docs/020-governance-and-policies/CHARTER.md

No changes needed.


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.

@Harsh16gupta
Copy link
Contributor Author

I’ve fixed the broken links in the Community README by updating them to point to existing files in the repo, as suggested.
Please let me know if you’d like me to squash the commits or make any further adjustments.

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 8ed98a7 into asyncapi:master Jan 27, 2026
9 of 10 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.

[Docs Bug 🐞 report]: Multiple Broken / Incorrect Links in Community README

3 participants