Entry point for agents working on Formle.
README.md— what the project is, status, quick previewdocs/ROADMAP.md— current scope and explicit non-goalsdocs/ARCHITECTURE.md— package layout, layer separation, dependency rulesdocs/CONVENTIONS.md— naming, file structure, commits, tests
Read the rest when relevant to the task:
docs/SCHEMA_SPEC.md— when working on schemas, parsing, or validationdocs/TOOLING.md— when working on build, lint, format, or release configCONTRIBUTING.md— when setting up dev environment
This documentation is the source of truth. It is written for both human contributors and AI agents — there is no separate "agent doc" with hidden rules. If something is not in docs/, it has not been decided. Do not invent answers from general knowledge.
When a decision is needed and the path forward is ambiguous:
- Choose the option that preserves the project's three core properties (headless, server-driven, DX-first TypeScript) — see
README.md. - Choose the option with the smaller scope.
- Document the decision in the appropriate file under
docs/.
When scope expands beyond what is documented, push back. The project's value is in what it deliberately does not do.
- Add features not listed in
docs/ROADMAP.mdfor the current version - Violate the dependency rules in
docs/ARCHITECTURE.md(especially: core never imports framework code) - Use
any,@ts-ignore, or unrestricted type assertions - Add styled components, theming, or any UI opinion to the library
- Introduce browser storage APIs (
localStorage,sessionStorage, etc.) in source
Everything else follows from the documented conventions.