Skip to content

docs: Audit and fix links across all README documentation files #115

@WilliamBerryiii

Description

@WilliamBerryiii

Problem

The repository contains 9 README files with 50+ links (internal and external) that need comprehensive validation to ensure:

  • All internal relative paths resolve correctly
  • External URLs are accessible (no 404s)
  • Microsoft URLs don't contain language-specific paths (/en-us/)
  • Frontmatter is valid across all files

Files to Audit

File Links Priority
README.md 16 High
.github/chatmodes/README.md 1 Medium
.github/instructions/README.md 1 Medium
.github/prompts/README.md 26 High
.github/workflows/README.md 5 Medium
.devcontainer/README.md 4 Medium
.vscode/README.md 3 Critical (missing frontmatter)
scripts/README.md 4 Low
scripts/linting/README.md 3 Low

Known Issues

Critical

  • .vscode/README.md - Missing YAML frontmatter with title: field (has code fence header instead)

Validation Required

  • All internal ../ relative paths resolve correctly
  • External GitHub URLs are accessible
  • External Microsoft URLs don't contain /en-us/ language paths
  • All external documentation links are accessible

Validation Process

  1. Run existing link validation: npm run lint:md-links
  2. Run language path check: npm run lint:link-lang
  3. Manual verification of relative path resolution
  4. Fix .vscode/README.md frontmatter

Acceptance Criteria

  • All internal links verified working
  • All external links return 200 status
  • No Microsoft URLs contain language-specific paths
  • .vscode/README.md has valid YAML frontmatter
  • CI link validation passes

Metadata

Metadata

Labels

documentationImprovements or additions to documentationmaintenanceMaintenance work, no version bump

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions