Skip to content

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

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.

  • QUICKSTART-DEV.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.

- `QUICKSTART-DEV.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
Contributor

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: f9086950-5f56-4601-9348-9dfeb6a348f4

📥 Commits

Reviewing files that changed from the base of the PR and between 53e8681 and 206f646.

📒 Files selected for processing (3)
  • QUICKSTART-DEV.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. (21)
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / rust-secrets
  • GitHub Check: Julia 1.10 - ubuntu-latest
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Julia 1.11 - ubuntu-latest
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Groove manifest check
  • GitHub Check: Julia 1.11 - macos-latest
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: analyze (actions, none)
🔇 Additional comments (3)
QUICKSTART-DEV.adoc (1)

41-41: LGTM!

ROADMAP.adoc (1)

224-224: LGTM!

SECURITY.adoc (1)

413-413: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contributing-guidelines links across the quickstart, roadmap, and security documentation to point to their current location.

Walkthrough

Three documentation files now link to .github/CONTRIBUTING.md instead of the repository-root path.

Changes

Contributing guide links

Layer / File(s) Summary
Update documentation links
QUICKSTART-DEV.adoc, ROADMAP.adoc, SECURITY.adoc
The contributing guidelines links now target .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 and concisely describes the documentation change. It states that references to the relocated contributing guide were corrected.
Description check ✅ Passed The description directly explains the link corrections and identifies all three affected files. It matches the pull request objectives.
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 guiding link
The hidden path is now in sync
Three pages point the proper way
No broken trails remain today
Soft paws approve the tidy change

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

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