Skip to content

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

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
  • 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
- `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: f28717f7-a872-4032-b8e2-bdfc30653d13

📥 Commits

Reviewing files that changed from the base of the PR and between d5ca496 and f1896de.

📒 Files selected for processing (2)
  • QUICKSTART-DEV.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: scan / shell-secrets
  • GitHub Check: governance / Licence consistency
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Code quality + docs
  • 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 primary / Nix fallback policy
  • GitHub Check: governance / Security policy checks
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: analyze (actions)
  • GitHub Check: test (1.10, windows-latest, x64)
  • GitHub Check: test (nightly, macos-latest, x64)
  • GitHub Check: test (1.10, ubuntu-latest, x64)
  • GitHub Check: test (nightly, ubuntu-latest, x64)
  • GitHub Check: test (1.10, macos-latest, x64)
  • GitHub Check: test (1.11, macos-latest, x64)
  • GitHub Check: test (1.11, ubuntu-latest, x64)
🔇 Additional comments (2)
QUICKSTART-DEV.adoc (1)

41-41: LGTM!

SECURITY.adoc (1)

391-391: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contributing guidelines links in the developer quickstart and security documentation to point to the correct location.

Walkthrough

Two documentation links were changed from CONTRIBUTING.md to .github/CONTRIBUTING.md in QUICKSTART-DEV.adoc and SECURITY.adoc.

Changes

Documentation link updates

Layer / File(s) Summary
Contributing guidelines link corrections
QUICKSTART-DEV.adoc, SECURITY.adoc
Both contributing guidelines references now use .github/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 identifies the documentation fix and the relocation of the contributing guide. It accurately summarises the main change.
Description check ✅ Passed The description directly explains the guide relocation and identifies both documentation files with the corrected link paths.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR

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 path today
The guiding link now leads the way
Two pages point to one true door
No broken trail remains before
Hop, hop, docs are clear once more

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

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