Experimental shadcn Registry compatibility - #5973
Draft
josephfarina wants to merge 6 commits into
Draft
Conversation
Generate preview-only shadcn Registry JSON from the existing Astryx catalog. Add draft install commands, compatibility docs, tests, and a draft blog post without publishing the experiment to production.
Add a preview-only human entry point for the generated shadcn registry, with search, filters, install commands, docs links, support counts, and raw JSON access.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
github-actions
Bot
added
the
needs:design-review
github-actions
Bot
requested review from
cvkxx,
ernestt,
kentonquatman and
rubyycheung
September 3, 2026 16:52
Generate the registry origin from the active Vercel deployment so draft commands resolve to the same preview. Keep static guide examples origin-neutral until publication.
Remove the separate registry browser and move shadcn compatibility below each component’s usage, props, and examples. Keep the raw registry as a machine endpoint.
Contributor
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 |
Derive organized component, hook, showcase, example, and template paths from doc identities. Add slug overrides, compatibility aliases, collision checks, and a reviewed route lock so display edits or file renames cannot silently break public install URLs.
Make exampleFor optional for block docs. Standalone blocks now use /r/blocks/<slug>.json, while examples and showcases remain component-scoped; showcases still require component ownership.
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.
Summary
Architecture
The existing
.doc.mjsmetadata, sibling composition source, and owningpackage.jsonremain the source of truth. The docsite generator emits a static registry index and one JSON item per installable surface. There is no parallel hand-authored catalog.The normal Astryx component and template documentation remains the human browse experience. Applicable pages show a secondary shadcn command after their primary documentation. Raw machine routes are organized as
/r/components,/r/hooks,/r/showcases/<component>,/r/examples/<component>,/r/blocks, and/r/templates.exampleForis optional: unowned compositions are standalone blocks, while component-owned records become examples or showcases. IDs derive from stable doc/catalog identity, with optionalregistry.slug, compatibility aliases, collision checks, and a reviewed 921-route lock.Component items install the owning Astryx package and write a public re-export. Composition items write editable app code that imports published Astryx package paths. Fourteen compositions with local StyleX declarations are precompiled to compiler-free JSX during generation.
Experimental boundary
This is a draft experiment. Canary and PR previews emit the raw registry, guide, commands, and draft blog. The production
latesttarget removes the registry output and excludes the experimental content.Validation
exampleFor