Skip to content

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

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
  • README_STATUS.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • panel-clades/SECURITY.adoc: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
  • panel-clades/docs/QUICKSTART.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
- `README_STATUS.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `panel-clades/SECURITY.adoc`: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
- `panel-clades/docs/QUICKSTART.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: 6742b05f-c723-4b03-a604-f70a55e6011a

📥 Commits

Reviewing files that changed from the base of the PR and between db7eafe and 3773d67.

📒 Files selected for processing (4)
  • QUICKSTART-DEV.adoc
  • README_STATUS.adoc
  • panel-clades/SECURITY.adoc
  • panel-clades/docs/QUICKSTART.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. (26)
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / shell-secrets
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / rust-secrets
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Groove manifest check
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: analyze (javascript-typescript, none)
  • GitHub Check: validate
  • GitHub Check: estate-audit
  • GitHub Check: Validate K9 contracts
🧰 Additional context used
📓 Path-based instructions (1)
Annotate and document all files.

📄 CodeRabbit inference engine (panel-clades/.cursorrules)

Files:

  • panel-clades/docs/QUICKSTART.adoc
  • panel-clades/SECURITY.adoc
🔇 Additional comments (4)
QUICKSTART-DEV.adoc (1)

39-39: LGTM!

README_STATUS.adoc (1)

315-315: LGTM!

panel-clades/SECURITY.adoc (1)

413-413: LGTM!

panel-clades/docs/QUICKSTART.adoc (1)

59-59: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution guide links across the quickstart, status, security, and project documentation to reflect its new location.
    • Improved navigation for contributors by ensuring all references point to the correct guide.

Walkthrough

Four documentation links now reference .github/CONTRIBUTING.md. Each link uses a relative path appropriate to its document location.

Changes

Contribution guide link updates

Layer / File(s) Summary
Update contribution guide paths
QUICKSTART-DEV.adoc, README_STATUS.adoc, panel-clades/SECURITY.adoc, panel-clades/docs/QUICKSTART.adoc
The contribution guide links now point to the .github directory. No public declarations changed.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: metadatastician

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains that documentation links now point to the relocated .github/CONTRIBUTING.md guide and lists the affected files.
Title check ✅ Passed The title clearly and concisely describes the main change: updating 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 trail
The links now reach the proper rail
Through folders deep, the paths align
To .github, neat and fine
Hop by hop, the docs now shine

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

@sonarqubecloud

Copy link
Copy Markdown

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