# cupld Docs

This directory contains the public documentation for `cupld`.

## Start Here

- Agents should start with [`agents/README.md`](./agents/README.md).
- [`agents/README.md`](./agents/README.md) is also the canonical automation-contract reference for machine output and agent workflows.
- Use this file as the public docs map.
- The repo root [`README.md`](../README.md) is the short project overview.
- Treat `internal/` docs as historical planning and status material, not as the current CLI contract.

## Structure

- [`agents/`](./agents/): CLI and viewer usage docs

## Reading Order

1. [`agents/README.md`](./agents/README.md)
2. [`agents/visualise.md`](./agents/visualise.md)

## Authoring Rule

Keep public user-facing documentation under this tree. The root README should stay brief and point here.
