Skip to content

fix: broken contributing-guidelines link#2220

Merged
asyncapi-bot merged 3 commits intoasyncapi:masterfrom
shubham220420:shubham2204-2206
Jan 6, 2026
Merged

fix: broken contributing-guidelines link#2220
asyncapi-bot merged 3 commits intoasyncapi:masterfrom
shubham220420:shubham2204-2206

Conversation

@shubham220420
Copy link
Contributor

@shubham220420 shubham220420 commented Jan 6, 2026

Description

Related issue(s)

fixes #2206

Summary by CodeRabbit

  • Documentation
    • Updated onboarding guidance to point to the comprehensive contribution guidelines (replacing the prior link).
    • Reformatted the guidance line to render as a blockquote for clearer presentation.

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

@coderabbitai
Copy link

coderabbitai bot commented Jan 6, 2026

📝 Walkthrough

Walkthrough

Updated the onboarding doc to point the contributing-guidelines link to the repository's internal page ../010-contribution-guidelines and rendered that line as a Markdown blockquote in docs/000-onboarding/index.md.

Changes

Cohort / File(s) Summary
Documentation link & formatting
docs/000-onboarding/index.md
Changed link target from ../../CONTRIBUTING.md to ../010-contribution-guidelines and prefixed the line with a blockquote marker (>).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A lost link hopped off the trail,
I nudged it to ../010-contribution-guidelines with a tale,
Wrapped in a quote to point the way,
Now guides arrive without delay.

Pre-merge checks

✅ 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 clearly and concisely describes the main change: fixing a broken contributing-guidelines link, which is the primary objective of the PR.
Linked Issues check ✅ Passed The PR successfully addresses issue #2206 by updating the broken contributing-guidelines link from ../../CONTRIBUTING.md to ../010-contribution-guidelines in docs/000-onboarding/index.md.
Out of Scope Changes check ✅ Passed The PR contains only the necessary change to fix the broken link as specified in issue #2206, with no out-of-scope modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc3aae3 and 4d50868.

📒 Files selected for processing (1)
  • docs/000-onboarding/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/000-onboarding/index.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: preview

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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Jan 6, 2026

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.

just one change here

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit fe04738 into asyncapi:master Jan 6, 2026
14 checks passed
@thulieblack
Copy link
Member

@shubham220420 do you mind creating another PR updating the path, its direction to /docs instead of /doc/community

@shubham220420
Copy link
Contributor Author

@shubham220420 do you mind creating another PR updating the path, its direction to /docs instead of /doc/community

Yeah I will create another PR, but can you please clearly stats where exactly you want me to point the updated path, & isnt it feasible to apply the direct url ?

@thulieblack
Copy link
Member

We follow a structure for our docs and we should use relative links

@shubham220420
Copy link
Contributor Author

We follow a structure for our docs and we should use relative links

localy ./010-contribution-guidelines is working fine but logically ../010-contribution-guidelines should be working.

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.

[BUG] Broken link to AsyncAPI contributing guidelines on -docs/community/onboarding page

3 participants

Comments