Skip to content

[User Story] docs-12: Add CI Validation For Docs Command Examples And Cross-Site Links #440

@djm81

Description

@djm81

User Story

As a SpecFact contributor, I want CI to automatically validate that docs command examples match actual CLI implementations and cross-site links resolve, so documentation drift is caught before merge.

OpenSpec Change

  • Change folder: openspec/changes/docs-12-docs-validation-ci/
  • Parent Feature: [Feature] Documentation & Discrepancy Remediation #356 (Documentation & Discrepancy Remediation)
  • Priority: P2
  • Depends on: docs-05, docs-07, specfact-cli-modules/docs-06 through docs-10
  • Cross-repo: specfact-cli-modules/docs-12-docs-validation-ci

Scope

  • Script to extract command registrations from module source and compare against docs examples
  • Cross-site link validation (HTTP HEAD checks)
  • Redirect coverage tests
  • Integration into CI workflows
  • hatch run docs-validate command

Source Plan

specfact-cli-internal/docs/internal/implementation/2026-03-23-docs-refactoring-beginner-to-enterprise-plan.md

Metadata

Metadata

Assignees

Labels

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions