# Documentation

## Use ubq

- [Guide](guide.md): The API, the rules, and the commands.
- [API reference](api.md): Each export of the package, with its type.
- [Convert a project](convert.md): How to move a project from tap, node:test, vitest, jest, or mocha.
- [Configuration](config.md): Which files ubq runs, and the `ubq` key of `package.json`.
- [Agent skill](skill.md): The `use-ubq` skill that `ubq skill` writes for your agent.
- [License](license.md): Blue Oak Model License 1.0.0.

## Design

This documentation record how ubq was designed and built: the
decisions and their reasons, the measurements, and the status of
the work. Agents and people wrote them during the work, for the
agents and people who maintain the tool.

- [Goals](docs/goals.md): The goals of the project, from its author.
- [What agents need](docs/agent-needs.md): What an agent needs from a test tool. Written by an agent, before the design.
- [Decisions](docs/decisions.md): Each design decision, with its reason.
- [Measurements](docs/measurements.md): The measured costs that the design depends on.
- [Architecture](docs/architecture.md): The parts, the process model, events, coverage, and the store.
- [API design](docs/api-design.md): The test file API, and what is absent on purpose.
- [Events](docs/events.md): The events that a test process sends to the runner.
- [Status](docs/status.md): What is built, and the known limits.
- [Open questions](docs/questions.md): Points that wait for a decision.
- [Coverage on Bun](docs/bun-coverage.md): What ubq needs from Bun for coverage of each test.
- [Server](docs/server.md): The optional background server.