docs: rewrite README and expand CONTRIBUTING guide - #14
Merged
Conversation
Replace outdated references to six archived themes (aurora, fern, cedar, mono, base, galley) with the three active scaffoldable themes (canopy, shadcn, galley). Add architecture diagram, feature table, CI/license badges, CLI options, full workspace table, and links to ARCHITECTURE, CONTRIBUTING, MIGRATION, and PUBLISHING docs. Document Node 22 requirement, local scaffold workflow (--from), and archive/ directory. Co-authored-by: Cursor <cursoragent@cursor.com>
Rewrite contributor docs for the consolidated three-theme structure. Add detailed theme contribution workflow: contract requirements, step-by-step setup, review criteria, and CLI registration. Document local scaffold testing (--from), CI gates, PR checklist, and engine/CLI contribution paths. Clarify archive/templates/ purpose and e2e exclusion rationale. Co-authored-by: Cursor <cursoragent@cursor.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
This PR brings the repository's top-level documentation up to date with the current monorepo state after the theme consolidation (Canopy / Shadcn / Galley) and the 0.4.0 feature release.
README (
README.md)archive/templates/--theme,--openapi,-y) and theinkform-docsbinary name--from templates), and e2e test noteCONTRIBUTING (
CONTRIBUTING.md)Decisions
Test plan
templates/canopy,archive/templates/,packages/framework/ARCHITECTURE.md, etc.)scaffold.mjsmatches README/CONTRIBUTING theme list (canopy, shadcn, galley)Made with Cursor