Skip to content

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

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

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
@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: 61df015b-6301-41bd-85e3-f23cfdd324c9

📥 Commits

Reviewing files that changed from the base of the PR and between efc8177 and c11909f.

📒 Files selected for processing (1)
  • 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 / Workflow security linter
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: spark-theatre-gate / SPARK Theatre Gate
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Security policy checks
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / shell-secrets
  • GitHub Check: cargo test --features git-integration
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: idris2 0.8.0 --build git-reticulator-proofs
  • GitHub Check: CodeQL Analysis (actions, none)
  • GitHub Check: estate-audit
🔇 Additional comments (1)
QUICKSTART-DEV.adoc (1)

41-41: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the developer quickstart to link to the contributing guide in its current repository location.

Walkthrough

The developer quickstart now links to .github/CONTRIBUTING.md instead of CONTRIBUTING.md.

Changes

Quickstart documentation

Layer / File(s) Summary
Update contribution link
QUICKSTART-DEV.adoc
The Contributing section points to the contribution guide in the .github directory.

Priority: ⬇️ Low

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

Change: Bug fix

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarises the documentation change. It states that references to the relocated contributing guide were corrected.
Description check ✅ Passed The description directly explains the link correction in QUICKSTART-DEV.adoc and identifies the new .github/CONTRIBUTING.md path.
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’s new door
The quickstart points to it once more
The path is clear
The file is near
No wrong turn waits in store

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

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