Skip to content

Add documentation link validation workflow#2081

Open
Nokhrin wants to merge 1 commit into
progit:mainfrom
Nokhrin:experiment/docs-validation-20260614
Open

Add documentation link validation workflow#2081
Nokhrin wants to merge 1 commit into
progit:mainfrom
Nokhrin:experiment/docs-validation-20260614

Conversation

@Nokhrin

@Nokhrin Nokhrin commented Jun 14, 2026

Copy link
Copy Markdown

This PR adds automated documentation link validation to the progit2 repository using the docs-validator tool.

What was done

  • Integrated documentation link validation into the CI/CD pipeline
  • Configured automated scanning of all AsciiDoc documentation files
  • Generated comprehensive validation reports in Markdown format
  • Uploaded validation reports as artifacts for review

Validation Results

https://github.com/Nokhrin/progit2/actions/runs/27497642111/job/81275058615

The initial validation scan identified:

  • 50 errors - Broken external links that need attention
  • 142 warnings - Files without incoming links and links requiring manual verification
  • 113 files scanned across the entire documentation
  • 260 external links checked (83 broken)
  • 6 internal links checked (all valid)

Benefits

  1. Improved documentation quality: Catches broken links before they reach readers
  2. Automated quality control: Runs on every push and pull request
  3. Actionable reports: Detailed Markdown reports uploaded as artifacts
  4. Early detection: Identifies link rot and structural issues proactively
  5. Maintainability: Helps maintain documentation integrity over time

Key findings

Most errors are in external GitHub repository links that no longer exist (e.g., old grit repositories, example projects). The validation also identified many files that are not linked from other documentation pages, which may need better navigation structure.

The full validation report is available in the workflow artifacts for detailed review.


@Nokhrin Nokhrin changed the title ci: add GitHub Actions workflow for documentation validation Add documentation link validation workflow Jun 14, 2026
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