# AGENTS.md

Build Better Websites. Create modern, resilient user experiences with web fundamentals.

## Setup

```
pnpm install
```

## Commands

```
pnpm build              # produce a build
pnpm test               # run the test suite, must pass before any commit
pnpm typecheck          # type check without emitting
pnpm lint               # lint
pnpm format             # format
pnpm postinstall
pnpm changes:preview
pnpm changes:validate
```

## Layout

- `packages/` 1140 source files
- `demos/`    281 source files
- `docs/`     228 source files
- `scripts/`  43 source files
- `template/` 11 source files

## Conventions

- Tests live alongside the code they cover, following `demos/assets/app/assets.test.ts`.
- CI defines what passing means. See `.github/workflows/check-main.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/fetch-router/demos/cf-workers/worker-configuration.d.ts` is 347KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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.