# AGENTS.md

📑 PageIndex: Document Index for Vectorless, Reasoning-based RAG

## Setup

```
pip install -r requirements.txt
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `pageindex/` 93 source files
- `tests/`     9 source files
- `examples/`  1 source file

## Conventions

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

## Gotchas

- `tests/test_agent_tools.py` is 111KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.