Skip to content

docs: fix broken links - #2608

Merged
adecaro merged 2 commits into
mainfrom
docs-fix-broken-links
Nov 2, 2026
Merged

adecaro merged 2 commits into
mainfrom
docs-fix-broken-links

Conversation

@adecaro

@adecaro adecaro commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Fixes every broken link in docs/. A full-repo linkspector run went from 6 broken links to 0. Only link targets changed; no content was edited.

File Old target New target Why
docs/tokensdk.md services/network.md#finality-management services/network.md#3--finality-tracking The heading is now "3. Finality Tracking".
docs/token_sdk_usage.md ./tokenapi.md#building-a-token-transaction ./services/ttx.md#transaction-creation That heading no longer exists. The ttx section documents the same step (ttx.NewTransaction).
docs/evolution_summary.md drivers/dlogwogh.md#protobuf-messages drivers/dlogwogh.md#107-protobuf-message-definitions The section was renumbered to 10.7, and upgradability.md already uses this anchor.
docs/development/storage.md FSC blob/main/docs/platform/view/db-driver.md (404) FSC blob/main/docs/platform/view/services/db-driver.md FSC moved the doc. The link stays on main, like the other FSC links in docs/.
docs/development/idiomatic.md (×2) withcodeexample.com/... archive.org snapshots (20250916174054, 20251015043026) The domain no longer resolves, and the articles have no new home. The attribution text is kept.

Verification

  • linkspector over the whole repo (the same tool as md_links.yml): all hyperlinks valid.
  • misspell clean on the changed files; make checks-fast passed.
  • All three external targets return HTTP 200.

There is no linked issue: this is a small docs-only cleanup, found while checking links for #2605.

@adecaro adecaro added this to the Q4/26 milestone Nov 1, 2026
@adecaro adecaro added documentation Improvements or additions to documentation cleanup labels Nov 1, 2026
@adecaro adecaro self-assigned this Nov 1, 2026
@adecaro
adecaro requested review from AkramBitar and Effi-S November 1, 2026 09:28

@Effi-S Effi-S left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM,
@adecaro should we update md_links.yml to try and catch these in the future?

@Effi-S
Effi-S force-pushed the docs-fix-broken-links branch from 3d23a5c to 86a2883 Compare November 1, 2026 13:21
adecaro and others added 2 commits November 2, 2026 11:54
- tokensdk.md: network.md#finality-management -> #3--finality-tracking
- token_sdk_usage.md: tokenapi.md#building-a-token-transaction -> services/ttx.md#transaction-creation
- evolution_summary.md: dlogwogh.md#protobuf-messages -> #107-protobuf-message-definitions
- development/storage.md: FSC db-driver.md moved under docs/platform/view/services/
- development/idiomatic.md: withcodeexample.com no longer resolves; use archive.org snapshots

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>
- Add an offline lychee job (--include-fragments) that fails on broken
  relative links and #anchors in docs/ and root *.md files.
- Add a weekly/manual full Linkspector scan (filter_mode: nofilter),
  since the PR run only reports links on changed lines.
- Scope permissions per job.
- Document the checks in docs/development/documentation.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>
@adecaro
adecaro force-pushed the docs-fix-broken-links branch from 109b21c to a5ab200 Compare November 2, 2026 10:54
@adecaro
adecaro merged commit a92f8c2 into main Nov 2, 2026
223 checks passed
@adecaro
adecaro deleted the docs-fix-broken-links branch November 2, 2026 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants