docs(generator): document data provenance and source-of-truth rules - #1111
Closed
teallarson wants to merge 6 commits into
Closed
docs(generator): document data provenance and source-of-truth rules#1111teallarson wants to merge 6 commits into
teallarson wants to merge 6 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ARCHITECTURE.md described the pipeline but not where any individual field comes from, so tracing a wrong category or a missing callout back to its origin meant reading the generator end to end. Adds a pipeline diagram, a per-field provenance table, and the constraints that are not visible from any single file: - The output directory is also an input. Hand-authored documentationChunks, customImports, and subPages have no upstream source and survive only through previous-output carry-forward, so --force-regenerate and --overwrite-output discard them as a side effect. - src/shared/toolkit-schemas.ts is the one contract, validated on write by the generator and on read by the app. - metadata.category and docsLink come from a pinned design-system dependency and determine the page URL, making a version bump a routing change. An unrecognized category throws rather than falling back. - Toolkits are derived by grouping tools, not fetched as a list. - Absence and corruption are different failures, enforced on both halves. Also records the skip-toolkits/remove-toolkits distinction, the cached loader, and the shared modules under src/shared/. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
teallarson
force-pushed
the
docs/generator-architecture
branch
from
August 3, 2026 19:47
bebad0b to
532d544
Compare
…lve-pr-1111 # Conflicts: # tests/toolkit-data-cache.test.ts
Contributor
Author
|
outdated |
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.
Purpose
This draft records the provenance and source-of-truth rules for the toolkit documentation pipeline. It explains how upstream API data, design-system metadata, generated enrichment, and hand-authored curation become the JSON consumed by the docs app.
How it fits
The document is intended to make field ownership and durability clear when debugging generated output or changing a pipeline stage. It covers the shared schema, category and URL derivation, toolkit grouping, corruption handling, exclusions, caching, and metadata completeness.
Status
The original draft described hand-authored prose as living only in generated JSON and warned that forced regeneration could delete it. #1112 now gives that prose a durable
curation/source, so this PR's prose-hazard section is outdated.This should be rewritten as the narrower, post-#1112 provenance document before it is considered for merge. The current draft is retained only as a reference for that rewrite.