feat(docs): docs-management pipeline POC (docs-kit + outlines + AppShell renderer)#396
Draft
interacsean wants to merge 2 commits into
Draft
feat(docs): docs-management pipeline POC (docs-kit + outlines + AppShell renderer)#396interacsean wants to merge 2 commits into
interacsean wants to merge 2 commits into
Conversation
Pure moves (no content change) so history/lineage is preserved:
- component docs: docs/components/{button,dialog,data-table}.md → the
colocated *.docs-outline.md source next to each component
- patterns: catalogue/src/pattern/{form/modal,list/dense-scan} PATTERN.md +
example .tsx → docs-src/patterns/ + docs/patterns/
The follow-up commit adapts these into the docs-kit outline/example format and
generates the docs/ output. Catalogue's skill generator is intentionally left
to regress — it will be retired and regenerated from these docs later.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
interacsean
force-pushed
the
1549-docs-management-overhaul
branch
from
July 24, 2026 00:45
bfa683d to
b4814a1
Compare
…nderer) Builds on the prep-move commit. Adds packages/docs-kit (ts-morph type-surface extractor + hasher, coverage reconciler, auto prop tables, deterministic check/sync CLI that formats before hashing), adapts the moved component docs into *.docs-outline.md + authored examples, adapts the moved catalogue patterns (form-modal, list-dense-scan) into the outline/example format, adds a styling concept, generates docs/ + docs-manifest.json, the resync-docs skill, and an AppShell file-based docs-app that renders prose + live examples. Patterns are sourced from catalogue/src/pattern (moved in the prep commit); catalogue's generator is knowingly regressed pending its retirement. Refs: tailor-inc/platform-planning#1549 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
interacsean
force-pushed
the
1549-docs-management-overhaul
branch
from
July 24, 2026 05:48
b4814a1 to
2ab5dd5
Compare
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
1 participant
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.
Pilot for the documentation management overhaul. Tracking issue: tailor-inc/platform-planning#1549 · Decision record: #387
What this is
A one-way source → output docs pipeline, proven end-to-end on 3 components + 2 patterns + 1 concept. Humans author intent; a deterministic tool generates and gates.
*.docs-outline.md(prose + English example intents +sourcesglobs) and the runnable*.examples.tsx. Everything underdocs/is generated — never hand-edited.packages/docs-kit(new, private): ts-morph type-surface extractor + hasher, coverage reconciler, auto-generated first-party prop tables, markdown assembler (extracts fences from the examples), and a deterministic no-LLMcheck/syncCLI.docs/docs-manifest.json. Type-surface + outline hash mismatch blocks; snapshot hash is advisory; a hand-edited generated file blocks. Coverage reconciled both ways vsindex.ts(uncovered → advisory during migration; a unit owning zero exports → block).syncformats output before hashing so the pre-commit oxfmt hook is idempotent.examples/docs-appis a real AppShell app using file-based routing — routes + sidebar auto-generated fromsrc/pages/, live in-place examples globbed fromdocs/(no copy).docs-update.lock.ymlbot in favour of a localresync-docsskill + the pre-merge gate.Verified
docs-kitbuilds + type-checks;docs:checkexit 0.examples.tsxtype-check against core (the "examples compile in CI" gate).Not included / follow-ups
defaultVariantsextraction).docs-kitgenerating the per-unitpage.tsxstubs.docs:checkinci-packages.yaml; pre-commit warn) + deletingdocs-update.lock.yml.enforceCoverageon.See
decisions/documentation-management-overhaul.mdfor the full design + Implementation notes.🤖 Generated with Claude Code