# AGENTS.md

The headless rich text editor framework for web artisans.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev      # run locally
pnpm start    # run the app
pnpm build    # produce a build
pnpm test     # run the test suite, must pass before any commit
pnpm lint     # lint
pnpm format   # format
pnpm check    # lint and type check
pnpm cz
```

## Layout

- `packages/`            941 source files
- `demos/`               493 source files
- `packages-deprecated/` 28 source files
- `scripts/`             4 source files

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/__tests__/resolve-publish-config.test.mjs`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `demos/src/Examples/Book/content.js` is 1193KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.