# AGENTS.md

Welcome to a calmer internet

## Setup

```
npm ci
```

## Commands

```
npm run start          # run the app
npm run build          # produce a build
npm run test           # run the test suite, must pass before any commit
npm run lint           # lint
npm run build:ui
npm run start:bloat
npm run import
npm run import:dumps
```

## Layout

- `src/`     747 source files
- `scripts/` 19 source files
- `tools/`   11 source files
- `build/`   1 source file
- `locales/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/pr-test.yml`.
- 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

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `src/zen/@types/lib.gecko.dom.d.ts` is 1066KB. 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.