Documentation Navigation
Authoritative foundation
Read these five documents first. They define Krometrail's current direction and intended system contracts:
- VISION.md — product thesis, audience, boundaries, and success criteria.
- SPEC.md — externally observable browser, recording, capability, and failure contracts.
- ARCHITECTURE.md — Rust workspace, component boundaries, data flow, storage, and failure isolation.
- VISUAL-EVIDENCE.md — temporal artifact vocabulary, provenance, and interpretation rules.
- EVALUATION.md — capture, artifact, browser-control, and agent-effectiveness validation.
The foundation documents intentionally describe capabilities that are being built in stages. The current executable state is documented in the development guide and the runtime reference; do not turn an intended capability into a command example until its implementation exists.
Public documentation
- Installation — choose the Claude Code/Codex plugin or standalone binary path.
- Use Krometrail with your agent — practical prompts, evidence choices, and fix-verification workflow.
- Troubleshooting — plugin activation, browser discovery, MCP, permission, and storage recovery.
- Manual MCP configuration — connect a standalone binary to an MCP client.
- Command reference — the installed binary's command surface.
- Configuration reference — current environment and per-session capture settings.
Contributor documentation
- Development — Rust build, test, lint, run, release, and docs-tooling commands.
- Browser fixtures — retained target applications and their current uses.
Versioned technology research
- Rust CDP transport — 2026-07 — source-grounded comparison of
cdpkit,chromey, and an owned transport, plus the real-browser selection gate.
Documentation is part of the current repository contract. Remove or update a page when the executable or workspace no longer supports its claims; do not preserve old runtime instructions as compatibility guidance.