Skip to content

fix: repair stale documentation links and link-checker coverage#828

Open
yjkellyjoo wants to merge 4 commits into
masterfrom
worktree-fix-stale-links
Open

fix: repair stale documentation links and link-checker coverage#828
yjkellyjoo wants to merge 4 commits into
masterfrom
worktree-fix-stale-links

Conversation

@yjkellyjoo

Copy link
Copy Markdown
Member

What does this PR resolve? 🚀

Audit and repair of stale/broken links across the docs, plus a link-checker fix so its llms.txt coverage report stops flagging redirect stubs.

  • Fix broken/stale external links across 12 doc pages (a dead 404, moved repos/domains, retired support articles)
  • Correct the stale concepts/DISC entry in static/llms.txt and add two missing content pages
  • Remove an orphaned, empty verify.md placeholder page
  • Teach the link checker to skip client-redirect stub pages when computing llms.txt coverage

Details 📝

  • External links (fix(docs)): ethersphere/examples links mastermain and the dead basic-static-website entry merged into the website example; golang.orggo.dev; jqlang.github.io/jqjqlang.org (5 files); claude.com/claude-code/product/claude-code; ENS support-article new slug; retired Microsoft Defender support article → current page; Gnosis validators → validategnosis.com; grant and desktop-subdomain links → canonical URLs; "awesome list" → internal /docs/references/awesome-list.
  • Intentionally left as-is (verified false positives): www/locale/geo canonicalizations, bee/releases/latest (always-latest redirect), valid Discord invites, and bot-blocked-but-live sites (gnosisscan, npmjs, gnu.org, readthedocs).
  • llms.txt (fix(llms)): dropped a trailing slash on the DISC index entry (flagged stale); added Multi-Author Blog and Developer Resources entries.
  • verify.md: orphaned draft (not in sidebars.js, unlinked, placeholder body) — removed.
  • Link checker (fix(scripts)): checkLlmsTxt() now skips @docusaurus/plugin-client-redirects meta-refresh stubs, cutting llms.txt "missing pages" noise from 26 → 4 (only intentional nav-landing intros remain).
  • Follow-ups (not in this PR): stale links in the community awesome-swarm list are fixed upstream separately; Fair Data Society links (fairdrop 502, xdai RPC) held pending a team check.

Checklist ✅

  • Merged latest master and resolved conflicts
  • npm run build succeeds
  • Links checked (npm run check:links) where relevant
  • static/llms.txt updated if pages were added / renamed / deleted
  • Content follows CODING.md conventions (Swarm vs swarm, ..)
  • Self-reviewed the diff
  • Commits are signed off (git commit -s)

🤖 Generated with Claude Code

yjkellyjoo and others added 4 commits July 9, 2026 15:05
- delete docs/bee/installation/verify.md, a draft placeholder whose body was just the filename and a stray Bee PR link
- page was not referenced anywhere: absent from sidebars.js, unlinked from other docs, no redirect in docusaurus.config.mjs, and not indexed in llms.txt
- removal drops one entry from the llms.txt coverage validator's missing-pages list

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
- resources-md: fix 404 by merging the removed examples/basic-static-website entry into the website entry, and switch all six ethersphere/examples links from the renamed master branch to main
- resources-md: repoint retired desktop.ethswarm.org subdomain to ethswarm.org/build/desktop
- build-from-source: update golang.org -> go.dev (URL and link text, x2) after the Go site rebrand
- ai-agent-skills: update claude.com/claude-code -> claude.com/product/claude-code (x2)
- jq: update jqlang.github.io/jq/ -> jqlang.org/ across getting-started, package-manager, shell-script, bee-api, and starting-a-test-network after jq moved to its own domain
- community: repoint retired grants.ethswarm.org subdomain to the grants programme page, and point the Swarm 'awesome list' text to the internal /docs/references/awesome-list page instead of the generic awesome.re badge redirect
- host-your-website: update the ENS support article to its new slug (same article id 12275979)
- connectivity: replace the retired Microsoft KB 4028544 Defender Firewall article with its current Windows Security page
- glossary: update gnosis.io/validators -> validategnosis.com after the Gnosis validators rebrand

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
- drop the trailing slash on the DISC entry (/docs/concepts/DISC/ -> /docs/concepts/DISC) so it matches the built URL; resolves the sole stale llms.txt entry
- add Multi-Author Blog under 'Host websites on Swarm'
- add Developer Resources under 'Build applications on Swarm'

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
- filter out @docusaurus/plugin-client-redirects meta-refresh stub pages when
  computing llms.txt build coverage, so old-URL forwards no longer count as
  "missing from llms.txt"
- detect stubs by the http-equiv="refresh" marker in their build HTML
- reduces recurring false-positive noise (missing pages 26 -> 4; only genuine
  navigation-landing intros remain)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
@yjkellyjoo yjkellyjoo self-assigned this Jul 9, 2026
@netlify

netlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploy Preview for test-twitter-preview-testing-3 ready!

Name Link
🔨 Latest commit 283b959
🔍 Latest deploy log https://app.netlify.com/projects/test-twitter-preview-testing-3/deploys/6a4f3d6e1754f50007f5f9dd
😎 Deploy Preview https://deploy-preview-828--test-twitter-preview-testing-3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@yjkellyjoo yjkellyjoo requested review from GasperX93 and crtahlin July 9, 2026 06:23

@GasperX93 GasperX93 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — verified every changed link resolves rather than eyeballing them.

Checked and confirmed:

  • All 18 new links return 200 (go.dev, jqlang.org, new ENS slug, all 6 examples/tree/main/... paths, ethswarm.org/build/desktop, claude.com/product/claude-code, validategnosis.com, grants URL, and the 3 llms.txt targets).
  • validategnosis.com is legit — "Gnosis Chain Validator," the current dedicated validator site.
  • basic-static-website is a genuine 404 on both main and master — correct to remove.
  • verify.md is an orphaned stub, unreferenced in sidebars.js and llms.txt — safe to delete, no dangling nav.
  • New internal /docs/references/awesome-list target resolves live (build-generated) — better than the old generic awesome.re.
  • check_links.ts meta-refresh skip is sound and well-commented.

One note (not blocking): most of the old links still 200 via redirect (jqlang.github.io/jq, the old ENS slug, mastermain, desktop.ethswarm.org, claude.com/claude-code, grants.ethswarm.org, gnosis.io/validators) — so these are stale-link canonicalizations rather than dead-404 repairs; only basic-static-website and the retired MS Defender article were truly broken. Canonical URLs are more durable, so it's a net improvement either way. Nice cleanup.

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.

2 participants