Skip to content

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

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
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: b2ca8cbf-9b05-4092-b011-464e0478d5ef

📥 Commits

Reviewing files that changed from the base of the PR and between a1de1b8 and 4744127.

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

39-39: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the contributing guidelines link in the developer quickstart documentation.

Walkthrough

The quickstart document now links to .github/CONTRIBUTING.md for the contributing guidelines.

Changes

Quickstart documentation

Layer / File(s) Summary
Update contributing guidelines link
QUICKSTART-DEV.adoc
The link target changes from CONTRIBUTING.md to .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 and concisely describes the documentation fix. It identifies that references to the relocated contributing guide were updated.
Description check ✅ Passed The description directly explains the outdated path, the corrected .github/CONTRIBUTING.md location, and the affected file.
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 guiding trail
The quickstart link now will not fail
It hops to the hidden path
And keeps the docs on track
One small fix, a clearer trail

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

@sonarqubecloud

Copy link
Copy Markdown

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