Skip to content

Validate and fix all internal documentation links for SHIP-0041 #195

@adambkaplan

Description

@adambkaplan

Overview

This task audits all internal links in documentation, updates them to new paths, and validates all links work correctly as described in SHIP-0041.

Description

Audit all internal links in documentation, update to new paths, and validate all links work correctly. Use automated tooling where possible to identify broken links.

This includes:

  • Markdown links within documentation files
  • Navigation links
  • Cross-references between documents
  • Links in code examples or snippets

Acceptance Criteria

  • All internal links updated to new paths
  • Link validation tooling run (if available)
  • All links verified to work
  • No broken links in documentation
  • All relative links use correct paths
  • External links validated (if time permits)

Dependencies

  • Blocks: None
  • Blocked by: Configure Hugo aliases for all moved content (Issue 10)

Technical Notes

  • Use tools like grep or ripgrep to find all markdown links: \[.*\]\(.*\)
  • Consider using link checking tools like htmltest or lychee if available
  • Update relative paths to match new directory structure
  • Test all links in local Hugo preview
  • Consider creating a CI/CD check to validate links on every PR

Generated-by: Cursor

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/documentationCategorizes issue or PR as related to documentation.

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions