ui-automation-control-plane

Docs Index

This is the public navigation map for Prooflane. Start with the layer that matches the WebUI-testing job you actually want to do, then go deeper only when you need more detail.

Distribution Truth Today

Prooflane is already public through GitHub + GitHub Pages + public-safe docs, but it is not claiming package-registry or marketplace distribution that has not happened yet.

• Repo-owned now: MCP docs, public-safe guided demo, public proof docs, and the localhost-first stress-lab path.
• Remote GitHub routes exist: repository, homepage, Discussions, and release surfaces remain audit-backed rather than static proof.
• Ready but not live yet: the publish-ready MCP package @uiq/mcp-server, the planned prooflane-mcp CLI shape, and other external distribution listings that are prepared but not published.
• Companion skill host state: docs/skills/prooflane-mcp/ is listed live on ClawHub and still review-pending on OpenHands/extensions; that host state belongs to the companion skill lane only.
• Not published yet: npm, PyPI, additional public Skills marketplace listings beyond the ClawHub companion packet, public Docker images, and hosted SaaS claims.
• Distribution-ready summaries live in DISTRIBUTION.md and INTEGRATIONS.md.

Quick map:

• front door first: README.md + docs/get-started.md
• proof second: docs/proof-center.md
• MCP / skill later: services/mcp-server/ docs + docs/skills/prooflane-mcp/
• remote GitHub truth: re-check through docs/reference/public-readiness.md before treating homepage/release/discussion state as fresh fact

Use these two short pages when you want the truth without reading the full architecture stack:

• ../DISTRIBUTION.md
• ../INTEGRATIONS.md

Start Here

If you are trying to…	Read this first	Then go here
Understand the product without local setup	docs/examples/public-stress-lab-guided-demo.md	README.md
Understand the stress-lab story in 30 seconds	README.md	docs/why-prooflane.md
Get a localhost-first result fast	docs/get-started.md	docs/how-to/mcp-quickstart-1pager.md
Connect Codex, Claude Code, or another MCP-capable client	docs/how-to/mcp-agent-review-loop.md	docs/how-to/mcp-clients-setup.md
See bilingual operator guidance in the Command Center	README.md	docs/get-started.md
Understand the testing pyramid and coverage gates	docs/reference/testing-strategy.md	docs/quality-gates.md
Review the public launch story	docs/releases/v0.1.0-public-launch.md	docs/releases/v0.1.0-public-closure.md (historical snapshot)
Judge whether the repo is credible	docs/proof-center.md	docs/reference/ci-governance.md
Understand the runtime and architecture	docs/architecture.md	docs/reference/universal-api.md

Stress Lab Front Door

• README.md: public front door
• docs/examples/public-stress-lab-guided-demo.md: no-setup guided demo
• docs/get-started.md: localhost-first quickstart
• docs/why-prooflane.md: product story and differentiation
• docs/releases/v0.1.0-public-launch.md: first public release notes
• docs/releases/v0.1.0-public-closure.md: historical closure snapshot
• docs/faq.md: evaluation FAQ

Current Truth

• Canonical rules: docs/ai/agent-guide.md
• Architecture contract: docs/architecture.md
• Public boundary: docs/reference/public-readiness.md
• CI and branch-protection truth: docs/reference/ci-governance.md
• Public artifact policy: docs/reference/public-artifact-policy.md

Proof And Trust

• docs/examples/public-stress-lab-guided-demo.md: public-safe walkthrough of the product layers
• docs/proof-center.md: public proof map for the deeper governed layer
• docs/reference/public-readiness.md: public boundary
• docs/reference/public-artifact-policy.md: public-safe artifact rules
• docs/reference/ci-governance.md: required CI topology and thresholds
• docs/quality-gates.md: compact gate semantics
• docs/reference/root-governance.md: allowed root structure
• docs/reference/logging-governance.md: log sinks and retention
• docs/reference/compatibility-matrix.md: third-party contract map
• docs/reference/upstream-customizations.md: tracked third-party source customizations and local override record
• docs/reference/resolution-overrides.md: dependency override registry

Runtime And Integration Surfaces

• docs/architecture.md: canonical architecture contract
• docs/reference/integration-entrypoints.md: builder map for HTTP, MCP, frontend hooks, and generated client surfaces
• docs/reference/universal-api.md: API contract
• docs/reference/configuration.md: environment and configuration
• docs/reference/testing-strategy.md: testing pyramid, coverage thresholds, and the fastest verification entry
• docs/reference/dependency-governance.md: dependency policy
• docs/reference/runtime-storage-policy.md: runtime storage boundary
• docs/reference/cache-governance.md: cache classes and retention
• docs/reference/runtime-paths.md: runtime path contract
• docs/reference/logging-and-cache-policy.md: operator-facing storage policy

MCP

These docs describe the companion integration lane. They are real and usable today, but they are not the primary Prooflane product story.

• docs/reference/integration-entrypoints.md: builder entry map before you choose HTTP vs MCP vs repo-internal client code
• docs/how-to/mcp-agent-review-loop.md: the quickest truthful path for Codex, Claude Code, or another MCP-capable client
• docs/how-to/mcp-quickstart-1pager.md: fastest MCP path
• docs/how-to/mcp-clients-setup.md: client setup
• docs/mcp.md: full MCP contract
• docs/skills/prooflane-mcp/SKILL.md: generic in-repo companion skill scaffold for @uiq/mcp-server / prooflane-mcp

Suggested roles:

• Operators: start in the quickstart, then follow the operator path in docs/how-to/mcp-clients-setup.md
• Agents / MCP clients: use the agent path in docs/how-to/mcp-clients-setup.md
• Advanced reviewers: start in docs/mcp.md for proof, brief, and campaign tools

Task Routing

Task type	Read first	Gate path
Docs and public-surface work	docs/ai/agent-guide.md + docs/index.md	docs/quality-gates.md for gate semantics, then the exact repo fast command from docs/ai/agent-guide.md / package.json
Code changes	docs/ai/agent-guide.md + docs/architecture.md	docs/quality-gates.md for delivery-gate semantics, then the exact fast/full command from docs/ai/agent-guide.md / package.json
Full acceptance	docs/ai/agent-guide.md	docs/quality-gates.md for parity expectations, then the exact full-acceptance command from docs/ai/agent-guide.md / package.json
Public release review	docs/proof-center.md + docs/reference/public-readiness.md	docs/quality-gates.md plus the release-boundary commands recorded in docs/ai/agent-guide.md / package.json

Search Before Writing

1. rg -n "<keyword>" docs scripts backend frontend packages
2. sg -p '<AST_PATTERN>' backend frontend packages
3. bash scripts/dev/ast-search.sh '<AST_PATTERN>' backend frontend packages
4. rg --files docs | rg "agent|guide|gate|readme"

Notes

• The docs are intentionally layered: stress-lab entry first, proof second, deep governance third.
• Historical release and closure documents stay in the navigation map as historical context, not as current-truth dashboards.
• GitHub-side live settings such as homepage, topics, and social preview belong to the latest audit evidence, not to static docs prose.
• Generated reference docs remain valid only when their source governance configs and render checks stay in sync.

This site is open source. Improve this page.