Skip to content

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

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
  • 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
- `SECURITY.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `docs/QUICKSTART.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: 01a54950-24b9-48f0-8c5a-7388196f1a7c

📥 Commits

Reviewing files that changed from the base of the PR and between d3c808f and 11ada41.

📒 Files selected for processing (3)
  • QUICKSTART-DEV.adoc
  • SECURITY.adoc
  • 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. (33)
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Licence consistency
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / gitleaks
  • GitHub Check: Test (windows-latest, beta)
  • GitHub Check: Test (macos-latest, stable)
  • GitHub Check: Test (ubuntu-latest, stable)
  • GitHub Check: Test (ubuntu-latest, beta)
  • GitHub Check: Test (windows-latest, stable)
  • GitHub Check: Test (macos-latest, beta)
  • GitHub Check: Security Audit
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Code Coverage
  • GitHub Check: Groove manifest check
  • GitHub Check: analyze (rust, none)
🔇 Additional comments (3)
QUICKSTART-DEV.adoc (1)

39-39: LGTM!

SECURITY.adoc (1)

413-413: LGTM!

docs/QUICKSTART.adoc (1)

310-310: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contributing-guidelines links in the developer quickstart, security guidance, and user quickstart documentation.
    • Links now direct readers to the current contributing guidelines location.

Walkthrough

Three documentation links now point to the relocated .github/CONTRIBUTING.md file. The documentation-relative path is adjusted in docs/QUICKSTART.adoc.

Changes

Contributing Link Path Updates

Layer / File(s) Summary
Update contributing guidelines links
QUICKSTART-DEV.adoc, SECURITY.adoc, docs/QUICKSTART.adoc
The links now reference .github/CONTRIBUTING.md. The documentation-relative path uses ../.github/CONTRIBUTING.md.

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 describes the main change: updating documentation references to the relocated contributing guide.
Description check ✅ Passed The description accurately explains the relocation to .github/CONTRIBUTING.md and identifies all updated documentation files.
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 nested path now will not fail
Three links point to the right place
Clear documentation sets the pace
Hop, hop, done without a trace

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

@sonarqubecloud

Copy link
Copy Markdown

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