docs-disc phase1a: docs.schema.json + validate-docs.py (TDD)#45
Merged
Conversation
Lands rows P1.1, P1.2, P1.3 from the docs-discoverability phases tracker. Foundation for Phase 1 — schema + validator that the 7 tier-1/2 repos will adopt in their own P1.4/P1.5 sessions. - profile/docs.schema.json (P1.1): Draft 2020-12 schema for prose-doc frontmatter. 23-type doc_type enum + 5-state lifecycle enum + 6-vocab connections. Two variants (prose vs generated) gated on the `generated` field via if/then per spec §5.1. - profile/repo.meta.schema.json (P1.2): extended with optional `docs.generated_paths` array (enables §5.1 exclusion rule). Additive change; no schema_compat bump (this schema isn't routing-layer). - profile/build/validate-docs.py (P1.3): TDD'd validator covering spec §9 checks 0-4 — generated-doc bidirectional check (path↔marker), frontmatter present, required keys, doc_type enum, lifecycle enum. Skips docs/recipes/ (own schema; covered by `recipes-check`). --warn-only flag for the Phase 1 rollout. - Makefile + .github/workflows/ci.yml (P1.3b — bonus self-check): the meta-repo dogfoods the validator. `make check-docs` runs in CI in warn-only mode against .github/docs/. Surfaces 21 legitimate gaps (this repo wasn't in Phase 0's 7-repo backfill — to be addressed in P1.6) plus 1 real bug: cli-ux-plan.md uses `SUMMARY`, not in the 23-vocab. - docs/docs-discoverability/phases-tracker.md: P1.1/2/3/3b → done; Phase 1 row → in-progress; CI checks #0-4 → done; #5-8 carved into new row P1.11 (validator-side follow-up). Tests: 13 new in test_validate_docs.py; full suite 129/129 green. Out of scope (separate sessions per "one session ↔ one repo" rule): P1.4/P1.5 (per-repo make + CI in each of the 7 repos), P1.6/P1.7 (lifecycle/owner backfill across 108 docs), P1.8/P1.9 (m-stdlib generated_paths declaration), P1.11 (validator checks 5-8). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Lands rows P1.1, P1.2, P1.3 from the docs-discoverability phases tracker. Foundation for Phase 1 — schema + validator that the 7 tier-1/2 repos will adopt in their own P1.4/P1.5 sessions.
profile/docs.schema.json: Draft 2020-12 schema for prose-doc frontmatter. 23-typedoc_typeenum + 5-statelifecycleenum + 6-vocabconnections. Two variants (prose vs generated) gated on thegeneratedfield viaif/thenper spec §5.1.profile/repo.meta.schema.json: extended with optionaldocs.generated_pathsarray (enables §5.1 exclusion rule). Additive; noschema_compatbump (this schema isn't routing-layer).profile/build/validate-docs.py+ 13 TDD'd cases: covers spec §9 checks 0–4 (generated-doc bidirectional path↔marker check, frontmatter present, required keys,doc_typeenum,lifecycleenum). Skipsdocs/recipes/(own schema; covered byrecipes-check).--warn-onlyflag for the Phase 1 rollout.Makefile+.github/workflows/ci.yml: the meta-repo dogfoods the validator.make check-docsruns in CI in warn-only mode against.github/docs/. Surfaces 21 legitimate gaps (this repo wasn't in Phase 0's 7-repo backfill — to be addressed in P1.6) plus 1 real bug:cli-ux-plan.mdusesSUMMARY, not in the 23-vocab.Out of scope (separate sessions per "one session ↔ one repo" rule):
make check-docs+ CI step in each of the 7 tier-1/2 reposlifecycle/ownerbackfill across 108 docsdocs.generated_pathsdeclarationTest plan
🤖 Generated with Claude Code