Skip to content

docs: fix broken links surfaced by linkinator - #262

Merged
yshyn-iohk merged 1 commit into
mainfrom
docs/fix-broken-links
May 22, 2026
Merged

docs: fix broken links surfaced by linkinator#262
yshyn-iohk merged 1 commit into
mainfrom
docs/fix-broken-links

Conversation

@yshyn-iohk

Copy link
Copy Markdown
Contributor

Summary

Repairs the real broken links (404 / dead-DNS / 410) that the Check Broken Links workflow reported in run 26278275914. Pairs with #261 which stabilizes the link-check job itself.

Categories of fix:

  • Dead staging-docs.atalaprism.io references (DNS gone) → repointed to the equivalent local pages under /documentation/adrs/decisions/ and /documentation/learn/...
  • OID4VP spec rename by OpenID Foundation → updated to openid-4-verifiable-presentations-1_0.html
  • Keycloak docs reorgdocs/22.0.0/authorization_servicesdocs/latest/authorization_services; securing_apps#_token-exchangesecuring-apps/token-exchange
  • w3c-ccg.github.io/did-resolution (404) → w3.org/TR/did-resolution (the published W3C version)
  • Dead Google Drive / Google Doc / Trinsic / Tapir-goals links in historical ADRs → removed or repointed to working roots; text preserved

ADRs are treated as updatable in this PR (per user direction).

Auto-generated documentation/reference/Cloud Agent API/*.api.mdx files were intentionally not touched — the dead w3c-ccg.github.io/did-resolution references in them come from the cloud-agent submodule's OpenAPI spec and will re-appear on every gen-api-docs. That URL is skipped at the linkinator level in #261.

Test plan

  • Build the site locally (npm run build) and confirm no Docusaurus broken-link errors for the changed pages
  • After merge (and after ci: stabilize link-check + pin author on submodule auto-commits #261 lands), re-run the Check Broken Links workflow and confirm the broken count is at or near zero
  • Spot-check that the new in-repo ADR links resolve correctly in the rendered docs

🤖 Generated with Claude Code

Replaces dead URLs reported by the Check Broken Links workflow:

- quick-start.md: dead staging-docs.atalaprism.io tutorial link →
  local /documentation/learn/advanced-explainers/did-prism/
- develop/cloud-agent/authentication.md: 3× dead staging-docs ADR
  URLs → corresponding local /documentation/adrs/decisions/ pages;
  Keycloak securing_apps#_token-exchange (404) → securing-apps/
  token-exchange
- reference/specifications.md: OID4VP draft URL was renamed by
  the OpenID Foundation, openid-4-verifiable-credential-presentation
  → openid-4-verifiable-presentations
- ADR 2022-10-05 (tapir): removed gone Google Doc + collapsed
  tapir goals.html (404) into tapir.softwaremill.com root
- ADR 2022-10-06 (private keys): removed 404 Google Drive link,
  kept the text
- ADR 2023-04-05 (DID-linked resources): w3c-ccg.github.io/
  did-resolution → w3.org/TR/did-resolution; removed 404
  docs.trinsic.id template-service link
- ADR 2023-09-26 (wallet permissions): Keycloak docs/22.0.0/
  authorization_services → docs/latest/ (5 occurrences)
- ADR 2024-05-20 (DID URLs for resources): w3c-ccg.github.io/
  did-resolution → w3.org/TR/did-resolution

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Yurii Shynbuiev <yurii.shynbuiev@iohk.io>
@yshyn-iohk
yshyn-iohk requested a review from a team as a code owner May 22, 2026 19:30
@github-actions

Copy link
Copy Markdown

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@sonarqubecloud

Copy link
Copy Markdown

@yshyn-iohk
yshyn-iohk merged commit 3215a51 into main May 22, 2026
9 checks passed
@yshyn-iohk
yshyn-iohk deleted the docs/fix-broken-links branch May 22, 2026 20:02
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