Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs: turn on broken-anchor checking and fix what it finds

Open Beginner friendly
  • Is something wrong?
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
node.js, typescript
Domain
documentation

Research direction

Start with docusaurus.config.ts and enable broken-anchor checking so the build reports affected links. Run npm run build, correct each flagged anchor in the documentation, and rerun the build; done means the build passes with checking enabled.

Written by the indexing model from the issue text.

Description

documentation help wanted

Summary

docusaurus.config.ts sets onBrokenLinks: 'throw', so a link to a page that does not
exist fails the build. Anchors within a page are not covered by that setting, and several
cross-page links here point at specific headings — the deployment guide's operational note,
the attestation model's blast-radius section, individual API endpoints.

If one of those headings is ever renamed, the link keeps working but silently drops the
reader at the top of the page instead.

Acceptance criteria

  • onBrokenAnchors is set to fail the build rather than warn.
  • Every anchor link that the build then flags is corrected, and npm run build passes.

Getting started

Fork this repository, clone your fork, and add this repo as upstream:

git clone https://github.com/<your-username>/canopychain-docs.git
cd canopychain-docs
git remote add upstream https://github.com/Canopychain/canopychain-docs.git

Create a branch for this issue:

git checkout -b docs/check-broken-anchors

Suggested commit message:

docs: enable broken-anchor checking

Preview your changes with npm start, and run npm run build before pushing — the build
is what catches broken links. Then open a pull request from your fork against main and
link this issue. See the
contributing guide
for the full contribution guide.

Dominant language
TypeScript
Stars
5
Forks
3
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Canopychain/canopychain-docs

All issues in Canopychain/canopychain-docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.