Skip to content

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

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.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • SECURITY.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • asdf-acceleration-middleware/README.adoc: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
  • asdf-acceleration-middleware/docs/QUICKSTART.adoc: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
  • asdf-acceleration-middleware/docs/TPCF.adoc: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
  • asdf-augmenters/SECURITY.adoc: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
  • asdf-augmenters/asdf-acceleration-middleware/README.adoc: CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
  • asdf-augmenters/asdf-acceleration-middleware/docs/QUICKSTART.adoc: ../CONTRIBUTING.md -> ../../../.github/CONTRIBUTING.md
  • asdf-augmenters/asdf-acceleration-middleware/docs/TPCF.adoc: ../CONTRIBUTING.md -> ../../../.github/CONTRIBUTING.md
  • asdf-augmenters/asdf-ghjk/README.adoc: CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
  • asdf-augmenters/asdf-ghjk/docs/FAQ.adoc: ../CONTRIBUTING.md -> ../../../.github/CONTRIBUTING.md
  • asdf-augmenters/asdf-plugin-collection/plugins/nickel/SECURITY (1).adoc: CONTRIBUTING.md -> ../../../../.github/CONTRIBUTING.md
  • asdf-ghjk/README.adoc: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
  • asdf-ghjk/docs/FAQ.adoc: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
  • asdf-nickel-plugin/SECURITY (1).adoc: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
  • asdf-plugin-collection/plugins/nickel/SECURITY (1).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.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `SECURITY.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `asdf-acceleration-middleware/README.adoc`: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
- `asdf-acceleration-middleware/docs/QUICKSTART.adoc`: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
- `asdf-acceleration-middleware/docs/TPCF.adoc`: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
- `asdf-augmenters/SECURITY.adoc`: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
- `asdf-augmenters/asdf-acceleration-middleware/README.adoc`: CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
- `asdf-augmenters/asdf-acceleration-middleware/docs/QUICKSTART.adoc`: ../CONTRIBUTING.md -> ../../../.github/CONTRIBUTING.md
- `asdf-augmenters/asdf-acceleration-middleware/docs/TPCF.adoc`: ../CONTRIBUTING.md -> ../../../.github/CONTRIBUTING.md
- `asdf-augmenters/asdf-ghjk/README.adoc`: CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
- `asdf-augmenters/asdf-ghjk/docs/FAQ.adoc`: ../CONTRIBUTING.md -> ../../../.github/CONTRIBUTING.md
- `asdf-augmenters/asdf-plugin-collection/plugins/nickel/SECURITY (1).adoc`: CONTRIBUTING.md -> ../../../../.github/CONTRIBUTING.md
- `asdf-ghjk/README.adoc`: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
- `asdf-ghjk/docs/FAQ.adoc`: ../CONTRIBUTING.md -> ../../.github/CONTRIBUTING.md
- `asdf-nickel-plugin/SECURITY (1).adoc`: CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
- `asdf-plugin-collection/plugins/nickel/SECURITY (1).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: e25638a7-074b-4960-a3cf-0d571f8a1658

📥 Commits

Reviewing files that changed from the base of the PR and between eb34df1 and 956a4a6.

📒 Files selected for processing (17)
  • QUICKSTART-DEV.adoc
  • README.adoc
  • SECURITY.adoc
  • asdf-acceleration-middleware/README.adoc
  • asdf-acceleration-middleware/docs/QUICKSTART.adoc
  • asdf-acceleration-middleware/docs/TPCF.adoc
  • asdf-augmenters/SECURITY.adoc
  • asdf-augmenters/asdf-acceleration-middleware/README.adoc
  • asdf-augmenters/asdf-acceleration-middleware/docs/QUICKSTART.adoc
  • asdf-augmenters/asdf-acceleration-middleware/docs/TPCF.adoc
  • asdf-augmenters/asdf-ghjk/README.adoc
  • asdf-augmenters/asdf-ghjk/docs/FAQ.adoc
  • asdf-augmenters/asdf-plugin-collection/plugins/nickel/SECURITY (1).adoc
  • asdf-ghjk/README.adoc
  • asdf-ghjk/docs/FAQ.adoc
  • asdf-nickel-plugin/SECURITY (1).adoc
  • asdf-plugin-collection/plugins/nickel/SECURITY (1).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. (25)
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / gitleaks
  • GitHub Check: Groove manifest check
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: analyze (actions, none)
  • GitHub Check: analyze (rust, none)
  • GitHub Check: estate-audit
🧰 Additional context used
📓 Path-based instructions (2)
Follow consistent naming conventions Write clear, self-documenting code Include comments for complex logic Maintain comprehensive test coverage Write unit tests for all new features

📄 CodeRabbit inference engine (asdf-augmenters/asdf-acceleration-middleware/CLAUDE.md)

Files:

  • asdf-augmenters/asdf-acceleration-middleware/docs/QUICKSTART.adoc
  • asdf-augmenters/asdf-acceleration-middleware/README.adoc
  • asdf-augmenters/asdf-acceleration-middleware/docs/TPCF.adoc
Follow consistent naming conventions Write clear, self-documenting code Include comments for complex logic

📄 CodeRabbit inference engine (asdf-acceleration-middleware/CLAUDE.md)

Files:

  • asdf-acceleration-middleware/docs/TPCF.adoc
  • asdf-acceleration-middleware/README.adoc
  • asdf-acceleration-middleware/docs/QUICKSTART.adoc
🔇 Additional comments (17)
QUICKSTART-DEV.adoc (1)

39-39: LGTM!

README.adoc (1)

51-51: LGTM!

SECURITY.adoc (1)

413-413: LGTM!

asdf-acceleration-middleware/README.adoc (1)

213-213: LGTM!

asdf-augmenters/asdf-plugin-collection/plugins/nickel/SECURITY (1).adoc (1)

413-413: LGTM!

asdf-ghjk/README.adoc (1)

374-374: LGTM!

asdf-ghjk/docs/FAQ.adoc (1)

300-300: LGTM!

asdf-nickel-plugin/SECURITY (1).adoc (1)

413-413: LGTM!

asdf-plugin-collection/plugins/nickel/SECURITY (1).adoc (1)

413-413: LGTM!

asdf-acceleration-middleware/docs/QUICKSTART.adoc (1)

270-270: LGTM!

asdf-acceleration-middleware/docs/TPCF.adoc (1)

207-207: LGTM!

asdf-augmenters/SECURITY.adoc (1)

413-413: LGTM!

asdf-augmenters/asdf-acceleration-middleware/README.adoc (1)

213-213: LGTM!

asdf-augmenters/asdf-acceleration-middleware/docs/QUICKSTART.adoc (1)

270-270: LGTM!

asdf-augmenters/asdf-acceleration-middleware/docs/TPCF.adoc (1)

207-207: LGTM!

asdf-augmenters/asdf-ghjk/README.adoc (1)

374-374: LGTM!

asdf-augmenters/asdf-ghjk/docs/FAQ.adoc (1)

300-300: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution-guideline links across project READMEs, quick-start guides, FAQs, and security documentation.
    • Links now consistently point to the central contribution guidelines, improving navigation from nested project documentation.

Walkthrough

The pull request updates contribution-guideline links in 17 AsciiDoc files. Each link now targets .github/CONTRIBUTING.md with the required relative path.

Changes

Contribution link paths

Layer / File(s) Summary
Update contribution links
QUICKSTART-DEV.adoc, README.adoc, SECURITY.adoc, asdf-acceleration-middleware/..., asdf-augmenters/..., asdf-ghjk/..., asdf-nickel-plugin/..., asdf-plugin-collection/...
The documentation links now reference .github/CONTRIBUTING.md instead of CONTRIBUTING.md, with adjusted relative paths for nested files.

Priority: ⬇️ Low

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

Change: Bug fix

Suggested reviewers: metadatastician

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states that documentation references to the relocated contributing guide were updated. It accurately describes the main change.
Description check ✅ Passed The description directly explains the relocated guide and lists the corrected relative paths across the affected 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 guidance trail
Through nested paths, both wide and frail
The dot-GitHub sign now shines
Clear directions through the vines
Every link hops home without fail

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

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