fix(docs): repair broken in-repo links and anchors - #1797
Conversation
- Three READMEs linked their license as `LICENSE`, but the file is `LICENSE.md` and lives at the repository root, so the links under `docs/` and `examples/CRISP/` also needed the right relative depth. - `crates/compute-provider/Readme.md` linked `interfold.network` without a scheme, so it rendered as a relative path. - `CONTRIBUTING.md` linked a `#changelog` section that does not exist; the changelog is covered under Releases and Merging, so the word is now plain text. - `compute-provider.mdx` used a stale anchor; the heading in the CRISP setup guide is `Boundless Configuration`. - `examples/CRISP/program/README.md` pointed at `../README.md`, but the file is `../Readme.md`. The mismatch resolves on case-insensitive macOS and 404s on GitHub and Linux. `circuits/README.md:85` is deliberately left alone: it points at `bin/recursive_aggregation/wrapper/README.md`, and no `wrapper/` subtree exists anywhere in `circuits/`, so the surrounding table is stale rather than the link being mistyped. Flagged on theinterfold#1794 for a maintainer decision. Refs theinterfold#1794 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
@Toby1009 is attempting to deploy a commit to the Gnosis Guild Team on Vercel. A member of the Team first needs to authorize it. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe pull request corrects documentation links in repository guides, compute-provider documentation, and CRISP examples. It updates license paths, external URLs, table-of-contents text, and Boundless configuration references. ChangesDocumentation links
Estimated code review effort: 1 (Trivial) | ~3 minutes Mergeability Score: 🔵 Low · up to This documentation-only PR repairs several broken links and anchors, but CONTRIBUTING.md still leaves the Changelog unlinked despite the existing changelog file, so users may have to find it manually. The change is otherwise mergeable with explicit owner awareness. Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 8: Update the “Changelog” entry in CONTRIBUTING.md to link directly to
the repository’s root CHANGELOG.md file, replacing the removed invalid
`#changelog` anchor while preserving the existing entry text.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 3a7df81a-e29f-411d-b04a-9d06d2cbf4d8
📒 Files selected for processing (7)
CONTRIBUTING.mdREADME.mdcrates/compute-provider/Readme.mddocs/README.mddocs/pages/compute-provider.mdxexamples/CRISP/Readme.mdexamples/CRISP/program/README.md
The previous commit dropped the link because `#changelog` pointed at a section that does not exist, but that also removed the only path from the guide to the root `CHANGELOG.md`. Point the word at the file instead, so the sentence stays navigable. Refs theinterfold#1794 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Agreed — applied in 683c26e, using the suggested You are right that dropping the link went one step too far. The |
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com>
2 participants
What
Repairs the broken relative paths and heading anchors found in the audit.
README.md:487(LICENSE)LICENSE.md(LICENSE.md)docs/README.md:42(LICENSE)LICENSEunderdocs/(../LICENSE.md)examples/CRISP/Readme.md:276(LICENSE)LICENSEunderexamples/CRISP/(../../LICENSE.md)crates/compute-provider/Readme.md:4(interfold.network)(https://theinterfold.com)CONTRIBUTING.md:8[Changelog](#changelog)docs/pages/compute-provider.mdx:113#boundless-configuration-production-provingdocs/pages/CRISP/setup.mdx:97is### Boundless Configuration#boundless-configurationexamples/CRISP/program/README.md:63../README.md#configuration../Readme.md../Readme.md#configurationThe last one is worth calling out: the case mismatch resolves on case-insensitive macOS, so it looks
fine locally while 404ing on GitHub and on Linux checkouts.
For
CONTRIBUTING.mdthe guide's intro promised a Changelog section that was never written — thechangelog is actually discussed under Releases and Merging. Making the word plain text is the
smallest honest fix; happy to instead point it at
#releasesor write the section if you wouldprefer.
Deliberately not fixed here
circuits/README.md:85linksbin/recursive_aggregation/wrapper/README.md, which does not exist —and neither does any
wrapper/subtree undercircuits/, though the table just above it documentswrapper/dkg/*andwrapper/threshold/*paths. That makes it a stale section rather than a mistypedlink, so it needs a maintainer decision instead of a guess. Flagged on #1794.
Closes part of #1794 (sections 6 and 7, minus the
circuits/README.mdentry above).Checklist
the link layer: a script resolving every relative link and heading anchor across all 145
.md/.mdxfiles now reports 0 broken anchors, and the only remaining broken relative link isthe
circuits/README.mdentry left out on purpose.pnpm lint,pnpm check:license,pnpm check:docs, andpnpm check:invariantsall pass via the pre-push hook.changes.
agent/INVARIANTS.md. Nothing in the meta-invariant list istouched.
Summary by CodeRabbit