CodeIssuesPull RequestsActionsSecurityInsights
✨ AI
More
Settings

chore(docs): keep all docs clean + green with a timestamp CI gate #4080

Merged⚡ AI-generatedXSccantynz wants to mergeclaude/docs-clean-and-greenmainopened Jun 8, 2026
ccantynzcommented Jun 8, 2026

Originally written by @ccantynz-alt on GitHub.
Imported from https://github.com/ccantynz-alt/AlecRae.com/pull/51


Why

"All docs need to be clean and Green at all times." This makes that automatic and enforced, not aspirational.

What

  • scripts/check-docs.ts — scans every tracked *.md (excludes node_modules, build dirs, and the GitHub PR template) and fails if any doc lacks a valid Last updated: YYYY-MM-DD HH:MM UTC stamp. --fix adds a footer stamp or normalizes an existing one.
  • package.jsondocs:check and docs:fix scripts.
  • .github/workflows/docs.yml — runs docs:check on every push + PR. This is the always-green gate: a new or edited doc without a proper stamp turns the check red.
  • Baseline stamp — all 46 docs now carry the date+time stamp (the 6 pre-existing date-only stamps were upgraded in place; no prose touched).
  • CLAUDE.md — THE TIMESTAMP RULE now references the CI gate + commands; protocol wording fixed; stamp refreshed.

Design note

The gate checks presence + format, not "stamp must be today" — a hard "today" rule would falsely fail every PR that doesn't touch docs. Freshness stays a human rule (stamp-on-edit, daily cadence); the CI guarantees no doc is ever unstamped or malformed. That's what keeps it green at all times.

https://claude.ai/code/session_01McgJLnTbZG9mwhfwd5iAX3


Generated by Claude Code

Cross-repo impact

See what breaks downstream if this PR merges.

Analyze →
⮌ Merged

This pull request was merged into main.

c comment · e edit title · m merge · a approve · r request changes · ? shortcuts