Skip to content

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

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: 9471eec8-8c90-4c99-b1c3-4339382358e2

📥 Commits

Reviewing files that changed from the base of the PR and between 030214a and fa8fee9.

📒 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. (22)
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / rust-secrets
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Julia 1.10 - ubuntu-latest
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Julia 1.11 - macos-latest
  • GitHub Check: Julia 1.11 - ubuntu-latest
  • GitHub Check: Groove manifest check
🔇 Additional comments (3)
QUICKSTART-DEV.adoc (1)

41-41: LGTM!

SECURITY.adoc (1)

414-414: LGTM!

docs/QUICKSTART.adoc (1)

59-59: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contributing guidelines links in the developer quickstart, security documentation, and documentation quickstart.
    • Links now point to the contributing guidelines in the .github directory.

Walkthrough

The pull request updates three contributing-guidelines links. The links now point to .github/CONTRIBUTING.md, including the relative path required by docs/QUICKSTART.adoc.

Changes

Contributing Documentation Links

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

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change and lists the affected files, but it does not follow the repository template. It omits the Summary, Changes, RSR Quality Checklist, Testing, and Screenshots section… Reformat the description using the repository template. Add the required Summary and Changes headings, complete the RSR Quality Checklist, document the test command and result, and add screenshots or state that they are not applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation change: it repoints 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.
Full details: Description check

Explanation

The description explains the change and lists the affected files, but it does not follow the repository template. It omits the Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections.

  • Fix all pre-merge checks with AI

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 reads each line,
The patch grows clear beneath the moon,
Small changes hop in place,
Tests guard the garden path,
Reviews bloom before the dawn.

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

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