# AGENTS.md

Get your documents ready for gen AI

## Setup

```
uv sync
```

## Commands

```
make help
make setup
make hooks-install
make check           # lint and type check
make check-all
make validate
```

## Layout

- `docling/` 249 source files
- `tests/`   143 source files
- `docs/`    51 source files
- `scripts/` 4 source files
- `perfs/`   3 source files

## Conventions

- Tests live alongside the code they cover, following `tests/__init__.py`.
- CI defines what passing means. See `.github/workflows/cd-docs.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `docling/backend/html_backend.py` is 178KB. 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.