Skip to content

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

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.

  • README.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • ROADMAP.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • SECURITY.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.

- `README.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `ROADMAP.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `SECURITY.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: 950b26fe-85d3-4c83-84a5-4accb6c9c692

📥 Commits

Reviewing files that changed from the base of the PR and between a1e8df6 and 2535666.

📒 Files selected for processing (3)
  • README.adoc
  • ROADMAP.adoc
  • SECURITY.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. (18)
  • GitHub Check: secret-scan / gitleaks
  • GitHub Check: secret-scan / shell-secrets
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: secret-scan / rust-secrets
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
🔇 Additional comments (3)
README.adoc (1)

335-335: LGTM!

Also applies to: 360-360

ROADMAP.adoc (1)

535-535: LGTM!

SECURITY.adoc (1)

398-398: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated links to the contribution guidelines across the README, roadmap, and security documentation.
    • Links now point to the guidelines’ new location.

Walkthrough

The contribution guide links in README.adoc, ROADMAP.adoc, and SECURITY.adoc now reference .github/CONTRIBUTING.md.

Changes

Documentation links

Layer / File(s) Summary
Update contribution guide links
README.adoc, ROADMAP.adoc, SECURITY.adoc
Updated four contribution guide links to use .github/CONTRIBUTING.md. No functional or code changes were made.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states that documentation references were updated for the relocated contributing guide.
Description check ✅ Passed The description accurately explains the link updates in README.adoc, ROADMAP.adoc, and SECURITY.adoc.
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 guide link,
Four paths now point to the right place.
README, Roadmap, Security align,
No code hops or changes race.
The contribution trail is clear,
So the rabbit nibbles cheerfully here.

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

@hyperpolymath
hyperpolymath merged commit 7167800 into main Sep 19, 2026
19 of 22 checks passed
@hyperpolymath
hyperpolymath deleted the refactor/contributing-guide-link-repair branch September 19, 2026 13:37
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