Skip to content

Documentation

The documentation ships with the source repository. A hosted documentation site is not available yet.

  • README.md

    Quick start: run the stack locally, sign in, generate a plan and run it.

  • docs/ARCHITECTURE.md

    Control plane, orchestration, workers, AI gateway and data flow.

  • docs/AGENT_CONTRACTS.md

    Agent roles, the AI gateway contract and the trust model.

  • contracts/WORKER_PROTOCOL.md

    How browser workers receive work and report evidence.

  • contracts/REMOTE_WORKER_PROTOCOL.md

    Customer-hosted worker pools: enrollment, worker credentials and the HTTPS job protocol.

  • contracts/IMPACT_MAP.md

    Change-impact test selection: the impact-map/1 document, selection rules and run records.

  • prooflane mcp --help

    The MCP server: stdio and Streamable HTTP transports, its tools and an example client configuration.

  • api/openapi.yaml

    The REST API contract (OpenAPI 3.1).

  • docs/TEST_EXPORT.md

    Running exported Playwright bundles outside the platform.

  • docs/THREAT_MODEL.md

    Threats, mitigations and what is not yet covered.

  • docs/CAPABILITY_MATRIX.md

    What is available, in preview, or not available.