# BoardReadyOps

> BoardReadyOps checks whether a KiCad hardware revision is ready to fabricate and keeps the decision tied to the exact Git commit and GitHub evidence that produced it.

The public website and documentation describe the product and its supported workflows. Authenticated customer data, control-plane operations, runner APIs, billing, tokens, and other private application surfaces are intentionally excluded from public discovery.

## Product

- [Product overview](https://boardreadyops.com/index.md): What BoardReadyOps checks, how exact-commit evaluation works, and how release evidence is presented.

## Documentation

- [Documentation](https://docs.boardreadyops.com/index.md): Canonical technical documentation.
- [Quickstart](https://docs.boardreadyops.com/quickstart.md): Install and run BoardReadyOps.
- [GitHub Action](https://docs.boardreadyops.com/action.md): GitHub Action usage and inputs.
- [Reports](https://docs.boardreadyops.com/reports/html.md): Release evidence and report formats.
- [GitHub App permissions](https://docs.boardreadyops.com/security/github-app-permissions.md): Least-privilege GitHub App model.

## API

- [Public OpenAPI](https://boardreadyops.com/openapi.json): OpenAPI 3.1 contract for the public liveness and readiness endpoints only.

## Optional

- [Markdown sitemap](https://boardreadyops.com/sitemap.md): Human- and agent-readable discovery map for the public site.
- [Public agent guidance](https://boardreadyops.com/AGENTS.md): Installation, configuration, and usage orientation for coding agents.