Skip to content

ci: add documentation audit workflows#578

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-569-add-doc-audit-ci-workflow
Apr 4, 2026
Merged

ci: add documentation audit workflows#578
kcenon merged 1 commit into
mainfrom
docs/issue-569-add-doc-audit-ci-workflow

Conversation

@kcenon

@kcenon kcenon commented Apr 4, 2026

Copy link
Copy Markdown
Owner

Closes #569

Summary

  • Add doc-audit.yml — runs documentation audit in quick mode on PRs modifying docs/, README.md, README.kr.md, or CLAUDE.md
  • Add doc-audit-ecosystem.yml — weekly (Monday 3:23 AM UTC) ecosystem-wide audit of all 8 repos with matrix strategy and artifact uploads
  • Audit failures post findings as PR comments and block merge
  • Uses PYTHONPATH + RUNNER_TEMP for clean tool isolation

Test Plan

  • Verify doc-audit.yml triggers on docs/ file changes in PRs
  • Verify ecosystem workflow runs via workflow_dispatch
  • Verify audit report artifacts are uploaded correctly

Add per-project doc-audit.yml that runs on PRs modifying docs/ files,
and ecosystem-wide doc-audit-ecosystem.yml that runs weekly on Mondays.

The per-project workflow runs the audit tool in quick mode and comments
findings on the PR. The ecosystem workflow audits all 8 repos with full
checks and uploads JSON report artifacts.

Closes #569
@kcenon kcenon merged commit ec72188 into main Apr 4, 2026
25 of 26 checks passed
kcenon added a commit that referenced this pull request Apr 13, 2026
Add per-project doc-audit.yml that runs on PRs modifying docs/ files,
and ecosystem-wide doc-audit-ecosystem.yml that runs weekly on Mondays.

The per-project workflow runs the audit tool in quick mode and comments
findings on the PR. The ecosystem workflow audits all 8 repos with full
checks and uploads JSON report artifacts.

Closes #569
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.

docs(ci): Add documentation audit CI/CD workflow

1 participant