Skip to content

Commit ba8771d

Browse files
committed
docs(audit): rate docs quality by page and section
1 parent 474f8c6 commit ba8771d

14 files changed

Lines changed: 56426 additions & 17 deletions

audits/2026-06-15-docs-quality-pages.csv

Lines changed: 229 additions & 0 deletions
Large diffs are not rendered by default.

audits/2026-06-15-docs-quality-sections.csv

Lines changed: 2410 additions & 0 deletions
Large diffs are not rendered by default.

audits/2026-06-15-docs-quality.json

Lines changed: 52488 additions & 0 deletions
Large diffs are not rendered by default.

audits/2026-06-15-docs-quality.md

Lines changed: 459 additions & 0 deletions
Large diffs are not rendered by default.

pages/blueprints/ai-agent-sandbox/dapp-and-indexer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The sandbox app is iframe-first. The parent dapp should:
6262

6363
## Bad copy to avoid
6464

65-
Do not name the product after one harness. The Sandbox SDK supports OpenCode plus 12 peer backend types: Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, and CLI base. The current Sandbox UI picker exposes a subset plus NanoClaw. The AI Agent Sandbox blueprint's current all-harness sidecar advertises Claude Code, Codex, OpenCode, Kimi Code, and Gemini CLI. The product boundary is the sandbox service instance and operator API.
65+
Do not name the product after one harness. The public Sandbox SDK supports OpenCode plus 11 peer backend types: Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, and CLI base. The public Sandbox UI picker exposes a smaller product-policy subset. The AI Agent Sandbox blueprint's current all-harness sidecar advertises Claude Code, Codex, OpenCode, Kimi Code, and Gemini CLI. The product boundary is the sandbox service instance and operator API.
6666

6767
Use capability language instead:
6868

pages/blueprints/ai-agent-sandbox/runtime-and-harnesses.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Runtime backends, capability discovery, harnesses, and AI credentia
77

88
The sandbox is the product. Harnesses are tools inside the sandbox.
99

10-
Do not describe this blueprint as an OpenCode integration, a Codex integration, or a Claude integration. The Sandbox SDK supports OpenCode plus 12 peer backend types: Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, and CLI base. A blueprint service instance asks its operator for the live runtime set through `GET /api/capabilities`.
10+
Do not describe this blueprint as an OpenCode integration, a Codex integration, or a Claude integration. The public Sandbox SDK supports OpenCode plus 11 peer backend types: Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, and CLI base. A blueprint service instance asks its operator for the live runtime set through `GET /api/capabilities`.
1111

1212
## Runtime backends
1313

pages/blueprints/ai-trading/operator-requirements.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Public admission means public cost exposure. Every accepted bot can use CPU, dis
6262

6363
The operator install path defaults new bots to paper trading. Paper mode uses live market data and simulated fills; it should not move capital.
6464

65-
AI keys are optional. If you set `ZAI_API_KEY`, `ANTHROPIC_API_KEY`, `TANGLE_API_KEY`, or OpenCode model/env settings, agentic activation and chat can use those settings when the selected sidecar advertises OpenCode. Treat OpenCode as one harness inside the same capability model as Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, CLI base, or a smaller blueprint sidecar subset. The operator docs are clear: there is no built-in per-bot, per-day, or total LLM spend cap today. Use provider-side billing limits.
65+
AI keys are optional. If you set `ZAI_API_KEY`, `ANTHROPIC_API_KEY`, `TANGLE_API_KEY`, or OpenCode model/env settings, agentic activation and chat can use those settings when the selected sidecar advertises OpenCode. Treat OpenCode as one harness inside the same capability model as Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, CLI base, or a smaller blueprint sidecar subset. The operator docs are clear: there is no built-in per-bot, per-day, or total LLM spend cap today. Use provider-side billing limits.
6666

6767
## Public endpoint
6868

pages/blueprints/operator-matrix.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The three first-party blueprints do not fail the same way. A sandbox operator ru
4343

4444
## Harnesses are not the product boundary
4545

46-
The sandbox product is the sandbox service instance plus its operator API. The Sandbox SDK supports OpenCode, Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, and CLI base. The current all-harness sidecar in the sandbox blueprint advertises Claude Code, Codex, OpenCode, Kimi Code, and Gemini CLI through `GET /api/capabilities`.
46+
The sandbox product is the sandbox service instance plus its operator API. The public Sandbox SDK supports OpenCode, Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, and CLI base. The current all-harness sidecar in the sandbox blueprint advertises Claude Code, Codex, OpenCode, Kimi Code, and Gemini CLI through `GET /api/capabilities`.
4747

4848
That endpoint is the contract the app should read. Do not make docs or UI copy pretend OpenCode, Codex, or any one harness is the integration. Harness support can change by publishing a new sidecar image without changing the blueprint ABI.
4949

pages/infrastructure/harnesses.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ OpenCode is one harness. Do not describe Tangle's sandbox product, SDK, or AI Ag
99

1010
There are three related surfaces:
1111

12-
| Surface | Source of truth | Current harness set |
13-
| ---------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14-
| Published Sandbox SDK | `@tangle-network/sandbox` `BackendType` | OpenCode, Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, and CLI base. |
15-
| Current Sandbox UI picker | `sandbox-ui` harness picker | OpenCode, Claude Code, Codex, AMP, Factory Droids, Kimi Code, OpenClaw, NanoClaw, Hermes, and CLI base. The picker defers SDK backends such as Pi, Forge, ACP, and Cursor until copy and compatibility policy land. |
16-
| AI Agent Sandbox blueprint sidecar | The operator's `/api/capabilities` response | Claude Code, Codex, OpenCode, Kimi Code, and Gemini CLI in the current `ghcr.io/tangle-network/blueprint-sidecar:all-harness` image. |
12+
| Surface | Source of truth | Current harness set |
13+
| ---------------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| Published Sandbox SDK | `@tangle-network/sandbox` `BackendType` | OpenCode, Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, and CLI base. |
15+
| Public Sandbox UI picker | `sandbox-ui` harness picker | OpenCode, Claude Code, Codex, AMP, Factory Droids, Kimi Code, Hermes, and CLI base. The picker defers SDK backends such as Pi, Forge, ACP, and Cursor until copy and compatibility policy land. |
16+
| AI Agent Sandbox blueprint sidecar | The operator's `/api/capabilities` response | Claude Code, Codex, OpenCode, Kimi Code, and Gemini CLI in the current `ghcr.io/tangle-network/blueprint-sidecar:all-harness` image. |
1717

1818
The centralized sandbox infrastructure can expose a broader harness menu than a specific protocol-backed service instance. A blueprint service instance must read the operator endpoint before promising a harness to a user.
1919

@@ -34,12 +34,11 @@ The published SDK accepts these backend types:
3434
| Pi | SDK backend type; not surfaced in the current Sandbox UI picker. |
3535
| Hermes | Hermes coding harness. |
3636
| Forge | SDK backend type; not surfaced in the current Sandbox UI picker. |
37-
| OpenClaw | Dispatcher path for Claude, Codex, and Gemini CLIs. |
3837
| ACP | Agent Client Protocol bridge for ACP-compliant agent binaries. |
3938
| Cursor | Cursor Agent SDK backend. |
4039
| CLI base | Shell and workflow tools without a coding harness. |
4140

42-
The current Sandbox UI picker also surfaces NanoClaw, a local socket-bridge agent backend, while deferring Pi, Forge, ACP, and Cursor. Product docs should say which surface they mean.
41+
The public Sandbox UI picker can expose a smaller subset than the SDK. Product docs should say which surface they mean and should prefer `/api/capabilities` for live operator surfaces.
4342

4443
These are execution harnesses, not routing categories. Every coding harness runs inside the sandbox. Unless a profile, user setting, or operator config points elsewhere, model calls go through Tangle Router. Do not describe routing as a property of one harness.
4544

@@ -60,7 +59,7 @@ Read `GET /api/capabilities` before rendering a harness choice. The image tag is
6059

6160
Any public copy that names OpenCode must name the peer harnesses or link to this page. The correct framing is:
6261

63-
> The sandbox supports multiple harnesses. OpenCode is one adapter beside Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, CLI base, and blueprint sidecar images that may advertise a smaller set through `/api/capabilities`.
62+
> The sandbox supports multiple harnesses. OpenCode is one adapter beside Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, CLI base, and blueprint sidecar images that may advertise a smaller set through `/api/capabilities`.
6463
6564
The wrong framing is:
6665

pages/vibe/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The workbench sends execution to the sandbox runtime. Hosted runs use product/AP
2323

2424
## Profiles Power The Runtime
2525

26-
Workbench profiles configure the selected agent harness, model routing, per-agent prompts, and tool permissions. OpenCode sits beside 12 other Sandbox SDK backend types: Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, OpenClaw, ACP, Cursor, and CLI base. Protocol-backed service instances must still read their own `/api/capabilities` response.
26+
Workbench profiles configure the selected agent harness, model routing, per-agent prompts, and tool permissions. OpenCode sits beside 11 other public Sandbox SDK backend types: Claude Code, Kimi Code, Codex, AMP, Factory Droids, Pi, Hermes, Forge, ACP, Cursor, and CLI base. Protocol-backed service instances must still read their own `/api/capabilities` response.
2727

2828
## Start Here (By Role)
2929

0 commit comments

Comments
 (0)