docs: define template authoring architecture - #5942
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR Analysis Report
No new or modified components detected. Bundle Size SummaryNo component packages changed. Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | View full report |
c994808 to
bdfbd60
Compare
cixzhang
left a comment
There was a problem hiding this comment.
Template authors currently face inconsistent visibility because docsite live previews are selected by a separate hand-maintained registry. Please make one validated template catalog the membership source, with each consumer using an explicit projection. CLI may expose all eligible pages and blocks; init may select scaffoldable pages; docsite may exclude entries through catalog metadata. A valid exclusion such as scaffold: true on blank must remain supported. What should not remain contractual is a separate manual list whose membership can drift: current main has 49 non-scaffold page templates eligible for the docsite metadata registry but only 41 live previews, missing nine pages. Revise INV2/INV3, system model, change coupling, verification, and OQ1/OQ3 so intentional differences come from declared metadata and manual registration is recorded as a migration gap rather than accepted architecture.
|
OQ4 should be answered alongside catalog convergence. Source-specific authoring shapes may remain different, and first-party |
Why
Astryx has a detailed template contribution guide and a versioned grading rubric, but no repository architecture record connecting template source, metadata, discovery, previews, and the CLI. The review loop has evidence for grading a template but no durable map of the shipped system or its compatibility boundary.
Cindy started that record in #5915. This recovers its architecture half instead of duplicating the existing guide or rubric.
What
Project.templates(), andinit's built-in-page starter list.AST-017/DEC-2: slugs, metadata, and starter source are mutable catalog data; the surrounding CLI operation and response schema remain contractual.Three corrections from #5915 are deliberate:
template/search/layout use comprehensive discovery,Project.templates()re-collects integrations for project issue handling, andinituses a built-in-page-only starter list. The draft records that split and asks whether it should converge.The record stays
authority: draft. It does not changedesign:template-composition, the public wiki rubric, or package behavior.Validation
pnpm exec prettier --check docs/architecture/template-authoring.mdpnpm check:knowledgepnpm check:repogit diff --checkNo Changeset: this is a draft knowledge record and publishes no package change.