Skip to content

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

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: 1f8841cb-a67d-456a-bc8e-2198dae29f36

📥 Commits

Reviewing files that changed from the base of the PR and between 5199987 and 920dadc.

📒 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. (23)
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Groove manifest check
  • GitHub Check: analyze (actions, none)
🔇 Additional comments (2)
QUICKSTART-DEV.adoc (1)

39-39: LGTM!

SECURITY.adoc (1)

413-413: LGTM!


📝 Summary

Summary by CodeRabbit

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

Walkthrough

The quickstart and security documentation now link to .github/CONTRIBUTING.md instead of CONTRIBUTING.md.

Changes

Documentation link corrections

Layer / File(s) Summary
Update contributing links
QUICKSTART-DEV.adoc, SECURITY.adoc
Both contributing guideline links now target .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
Description check ✅ Passed The description accurately explains that documentation links now point to the relocated .github/CONTRIBUTING.md file and identifies both changed files.
Title check ✅ Passed The title clearly and concisely describes the main change: correcting documentation references to the relocated contributing guide.
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 sign
The paths now point to .github in line
Quickstart hops with clearer feet
Security follows the same neat route
Two links now land where readers meet

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

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