Skip to content

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

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

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
@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: f0489add-2c69-4aca-8e26-ce98b21eb164

📥 Commits

Reviewing files that changed from the base of the PR and between d92d619 and 48b6bc0.

📒 Files selected for processing (2)
  • README.adoc
  • ROADMAP.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. (16)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / gitleaks
  • GitHub Check: spark-theatre-gate / SPARK Theatre Gate
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: analyze (actions, none)
  • GitHub Check: build
🔇 Additional comments (2)
README.adoc (1)

431-431: LGTM!

ROADMAP.adoc (1)

577-577: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contributing-guidelines links in the README and roadmap to reference the relocated contribution guide.

Walkthrough

The contributing-guidelines links in README.adoc and ROADMAP.adoc now reference .github/CONTRIBUTING.md.

Changes

Documentation link updates

Layer / File(s) Summary
Update contributing links
README.adoc, ROADMAP.adoc
Both documents now link to .github/CONTRIBUTING.md instead of CONTRIBUTING.md.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation link updates caused by the relocated contributing guide.
Description check ✅ Passed The description accurately explains the guide relocation and identifies both updated documentation 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 the guide
The path now points inside
Two links hop in line
The docs stay clear and bright
Contributions wait inside

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

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