Skip to content

fix(docs): repoint references to the relocated contributing guide - #18

Merged
hyperpolymath merged 1 commit into
mainfrom
refactor/contributing-guide-link-repair
Sep 19, 2026
Merged

hyperpolymath merged 1 commit into
mainfrom
refactor/contributing-guide-link-repair

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

fix(docs): repoint references to the relocated contributing guide

The guide moved to .github/CONTRIBUTING.md; these references still resolved
against the old root location and 404 from where they are written. Rewritten
using the correct relative depth.

  • .github/CONTRIBUTING.md: in-guide links withdrawn one level to the root
  • MAINTAINERS.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md

The guide moved to .github/CONTRIBUTING.md; these references still resolved
against the old root location and 404 from where they are written. Rewritten
using the correct relative depth.

- `.github/CONTRIBUTING.md`: in-guide links withdrawn one level to the root
- `MAINTAINERS.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 55fbe66f-70a6-4957-b8d2-aba7153a9806

📥 Commits

Reviewing files that changed from the base of the PR and between 0f689cb and 9f217b4.

📒 Files selected for processing (2)
  • .github/CONTRIBUTING.md
  • MAINTAINERS.adoc

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (7)
  • GitHub Check: secret-scan / shell-secrets
  • GitHub Check: secret-scan / gitleaks
  • GitHub Check: secret-scan / rust-secrets
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: estate-rules
  • GitHub Check: CodeQL Analysis (actions, none)
  • GitHub Check: openssf-compliance
🔇 Additional comments (2)
.github/CONTRIBUTING.md (1)

9-9: LGTM!

Also applies to: 21-21

MAINTAINERS.adoc (1)

66-66: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated Governance and Affirmation links in the contributing guidance.
    • Corrected the “Contributing Guide” link in the maintainer documentation to point to the current guide location.

Walkthrough

The contribution documentation now uses parent-directory paths for Governance and Affirmation. The maintainers document now points to the contribution guide under .github.

Changes

Documentation link corrections

Layer / File(s) Summary
Update documentation link paths
.github/CONTRIBUTING.md, MAINTAINERS.adoc
The contribution document uses parent-directory paths for Governance and Affirmation. The maintainers document points to .github/CONTRIBUTING.md.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Bug fix

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: updating documentation references after relocating the contributing guide.
Description check ✅ Passed The description accurately explains the broken references and the path corrections in both changed files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

A rabbit checks each path with care
Governance links now lead there
Affirmation follows too
The guide points where it should do
Neat docs hop through every lair

Comment @coderabbitai help to get the list of available commands.

@hyperpolymath
hyperpolymath merged commit 2441e27 into main Sep 19, 2026
8 of 10 checks passed
@hyperpolymath
hyperpolymath deleted the refactor/contributing-guide-link-repair branch September 19, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant