Skip to content

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

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.

  • .github/CONTRIBUTING.md: in-guide links withdrawn one level to the root
  • examples/newsroom/README.adoc: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
  • playground/SECURITY.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.

- `.github/CONTRIBUTING.md`: in-guide links withdrawn one level to the root
- `examples/newsroom/README.adoc`: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
- `playground/SECURITY.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: dbe31558-a532-440a-9340-400984883e84

📥 Commits

Reviewing files that changed from the base of the PR and between 239170f and 8ec3544.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • examples/newsroom/README.adoc
  • playground/SECURITY.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. (18)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Security policy checks
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: spark-theatre-gate / SPARK Theatre Gate
  • GitHub Check: governance / Check Workflow Staleness
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md

[locale-violation] ~189-~189: LICENSE must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ... matching the file you are editing. See LICENSE.

(LICENCE_LICENSE_NOUN_SINGULAR)

🔇 Additional comments (3)
.github/CONTRIBUTING.md (1)

80-80: LGTM!

Also applies to: 189-189

examples/newsroom/README.adoc (1)

127-127: LGTM!

playground/SECURITY.adoc (1)

413-413: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Corrected links in contribution, licensing, roadmap, security, and example documentation so they resolve to the intended files.
    • Updated contributor guidance references across the project.

Walkthrough

The change corrects four relative Markdown and AsciiDoc links. The links now target the repository roadmap, licence, and contribution guidelines from their current documentation locations.

Changes

Documentation link corrections

Layer / File(s) Summary
Correct relative documentation links
.github/CONTRIBUTING.md, examples/newsroom/README.adoc, playground/SECURITY.adoc
Updated four relative links to use the correct parent-directory paths.

Priority: ⬇️ Low

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

Change: Bug fix

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation link updates for the relocated contributing guide.
Description check ✅ Passed The description directly explains the corrected references and lists all affected 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 link with care
Parent paths now lead there
Roadmaps, licences, guides align
Four neat trails now resolve fine
Documentation rests in line

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

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