Docs for agents

These docs are written to be read by agents as much as people. Every page is short, example-first, and available as plain text.

URLs

URL	Contents
/llms.txt	site-level pointer for agents
/docs/llms.txt	index: summary, requirements, and every page with its Markdown link
/docs/llms-full.txt	all pages in one file
/docs/llms-small.txt	all pages, compact
/docs/<page>.md	one page as Markdown — swap the trailing / for .md, e.g. /docs/guides/animation.md

Each page also has a Copy as Markdown button under its title, for pasting into a chat.

Tell your agent about them

Add this to your project’s AGENTS.md (or CLAUDE.md):

AGENTS.md

## Video (framefields)

This project renders video with the `framefields` npm package.

- Docs index: https://framefields.dev/docs/llms.txt — fetch a page's `.md` URL from it when you need details.
- Rules to follow: https://framefields.dev/docs/reference/rules.md
- Film entry: `src/film.ts` exports `buildFilm()`. Tokens live in `src/theme.ts`.
- Input files live in `assets/` and are stored with Git LFS. Run `git lfs pull` before rendering in a fresh checkout; a ~130-byte file starting with `version https://git-lfs` is an un-pulled pointer. Check `git lfs ls-files` lists new media before committing. Renders go to `output/` (gitignored).
- Verify cheapest first: `npm run typecheck`, `comp.lint()`, `npm run frames -- <n…>`, `npm run grid`, then `npm run render` (QA must pass).
- Open every PNG you render before claiming it looks right.
- Preview notes from people are in `.framefields/preview-notes/notes.json`.

Pick the right file

• Starting cold? llms-small.txt fits most context windows and covers everything.
• Working on one area? Fetch just that page’s .md from the index.
• Need effect props? /docs/reference/effects.md lists all 52 effects; the skills’ generated catalog has types, ranges and defaults.