Skip to content

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

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.

  • .github/CONTRIBUTING.md: in-guide links withdrawn one level to the root
  • QUICKSTART-DEV.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.

- `.github/CONTRIBUTING.md`: in-guide links withdrawn one level to the root
- `QUICKSTART-DEV.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: d7d0a66c-391f-42fe-ba9c-ebb24cde6c27

📥 Commits

Reviewing files that changed from the base of the PR and between ae9e38f and 8cbdd54.

📒 Files selected for processing (2)
  • .github/CONTRIBUTING.md
  • QUICKSTART-DEV.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. (24)
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: Cargo build + test (ephapax-cli, --no-default-features)
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Licence consistency
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: wasm-tools validate (emitted modules)
  • GitHub Check: governance / Security policy checks
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: analyze (javascript-typescript, none)
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Detect relevant changes
  • GitHub Check: detect-relevant-changes
🔇 Additional comments (2)
.github/CONTRIBUTING.md (1)

29-29: LGTM!

QUICKSTART-DEV.adoc (1)

39-39: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Corrected the link to machine-readable contribution policies.
    • Updated the developer quickstart link to the contribution guidelines.

Walkthrough

Two documentation links now point to the correct paths. The contribution policy link uses the parent directory. The quickstart links to .github/CONTRIBUTING.md.

Changes

Documentation link corrections

Layer / File(s) Summary
Correct documentation link targets
.github/CONTRIBUTING.md, QUICKSTART-DEV.adoc
The contribution policy link and the quickstart contributing-guidelines link now resolve from their current file locations.

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 summarises the documentation link updates caused by the contributing guide relocation.
Description check ✅ Passed The description accurately explains both documentation link corrections and matches the pull request changes.
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 careful trail
Links now point without fail
From quickstart pages, paths align
Policy files are easy to find
Documentation hops in line

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

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