docs: polish root README and add per-package READMEs#18
Merged
Conversation
|
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
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.
Root README
Fixes three kinds of issues against the writing rules in CLAUDE.md:
Define a form once — fields, validation, ... — in a single file→ parens).its own compact,There is also a Figma plugin,Useful for rapid prototyping and design handoffall cut or rephrased.https://formhaus.dev/playgroundand/playground(relative), both 404 on the deployed site. Now both point athttps://formhaus.dev/playground.htmlwhich is the real deployed URL.The Figma plugin mention was also clarified:
Available via manifest.json for nowwas too cryptic for people who haven't installed a local Figma plugin before. Now says explicitly: "Not on Figma Community yet, install as a local plugin viapackages/figma/manifest.json".Per-package READMEs
All four published packages had empty npm pages (no
readmefield in the published tarball). Verified by checkingregistry.npmjs.org/@formhaus/core/0.3.1which has noreadmeorreadmeFilename. npm auto-includesREADME.mdfrom the package directory regardless offileswhitelist, so these will appear on npm on the next publish.Each package gets a focused README:
packages/core/README.md— zero-dep engine usage example withFormEngine,setValue,validate,getSubmitValues. Lists what the engine covers (visibility, multi-step, async validation, definition validation).packages/react/README.md— React adapter,<FormRenderer definition={...} />example,componentsprop for custom UI kit.packages/vue/README.md— same for Vue 3 with<script setup>and:definitionprop.packages/figma/README.md— different shape: it's a Figma plugin, not an npm lib usage. Walks through local plugin install (clone, build, FigmaPlugins → Development → Import plugin from manifest), usage, and component map config.All four link back to https://formhaus.dev, https://formhaus.dev/playground.html, and the GitHub repo.
Effect on published packages
None until the next publish. This PR is docs-only, no code changes, no
package.jsonchanges. The README files will ship automatically with@formhaus/core@0.3.2/@formhaus/react@0.3.2/ etc. whenever the next release goes out.Test plan
pnpm build && pnpm teststill green (unchanged, but sanity)