Skip to content

docs(dx): close the small-batch backlog — golden path, example output framing, entry-surface discovery, archive completed plan#446

Merged
drewstone merged 1 commit into
mainfrom
docs/dx-close-small-batch
Jul 2, 2026
Merged

docs(dx): close the small-batch backlog — golden path, example output framing, entry-surface discovery, archive completed plan#446
drewstone merged 1 commit into
mainfrom
docs/dx-close-small-batch

Conversation

@drewstone

Copy link
Copy Markdown
Contributor

Closes out the small-batch items from the DX audit's examples + entry-surface clusters. Docs and example-output edits only — no src changes, no new exports.

Examples cluster

  • examples/README.md — resolves the "read in order" vs "read ONE" contradiction (ONE is now the headline); the quickstart becomes a $0-first golden path (driver-loop → improve → supervise) so both offline commands run before any key is needed; adds a "Research harnesses" row so ablation-suite/ is no longer the only directory absent from the catalog.
  • examples/supervise/README.md — explicit role line: smallest call here, graduate to supervisor-loop/ when workers need a real backend (backend is the only knob).
  • examples/improve/improve.ts — one framing line before the two bare result lines, so a runner knows what just happened.
  • examples/sanitized-telemetry-streaming — summary-first restructure: both runs print collector.summary() BEFORE the event wall (the verbose run previously never printed a summary at all); the redundant safe-only summary block is gone.
  • examples/stream-backends — 3-line preamble naming the four sections + the one shared drain before the SSE walls.
  • examples/coding-benchmark/README.md — trim: thesis to 3 sentences, offline-note + firewall-implementation + stats-reps + power-caveat compressed keeping every load-bearing name (routeCodingFields, assertNoHiddenLeak, gradeOnHidden, the 0.7/0.3 blend, cheat-vs-real numbers), the substrate-primitive inventory replaced by one line pointing at docs/canonical-api.md, the defineBenchmark rationale replaced by one line keeping the decision + revisit trigger. Run commands, measures table, files table, and Going live intact.

Entry cluster

  • README.md — two discovery bullets in "Where to go next" (docs/api/primitive-catalog.md as the generated anti-reinvention list; the import-subpath convention naming all 10 subpaths) + a one-line contributor breadcrumb.
  • docs/canonical-api.md — both §2 entry markers scoped: START HERE (running agents) / START HERE (self-improvement), matching §2.1's existing scoped form; no unscoped markers remain.
  • docs/benchmark-matrix-consolidation.md → docs/archive/ — the agent-runtime portion of that plan shipped (external adapters 5e2e81a0, DABStep 5d610e78, runBenchmarks feat(bench): runBenchmarks — the subset-runnable benchmark matrix unifier #420); archived with a status header; the surviving operational fact (the run-benchmarks-cli.mts subset sweep) is now on bench/HARNESS.md's Commands list.
  • docs/README.md — archive parenthetical gains the consolidation doc; intelligence-sdk row updated to the product-SDK framing (matches the in-flight rewrite of that doc).

Verification

  • pnpm run lint / pnpm run typecheck (incl. typecheck:examples) / pnpm run docs:check — all green ("OK — no drift").
  • pnpm test — 122 files, 1194 passed, 2 skipped.
  • Ran all three edited offline examples: framing line prints first (improve), summary precedes each event wall and the verbose run now has one (sanitized-telemetry-streaming), preamble first + clean no-key skip (stream-backends); all exit 0.
  • grep START HERE docs/canonical-api.md → only scoped occurrences; zero dangling links to the old consolidation path; every docs/*.md file is indexed in docs/README.md.

Follow-up (needs human confirm, not done here): delete the superseded feat/bench-external-adapters + feat/bench-dabstep-adapter branches; file the agent-lab issue for the cross-repo consolidation remainder (plan steps 3–5).

… framing, entry-surface discovery, archive completed plan

@tangletools tangletools left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Auto-approved drewstone PR — 7c2a954b

This PR was opened by the trusted drewstone account.
The full PR reviewer audit still runs separately and will publish findings if it detects issues.

tangletools · auto-approval · reason: drewstone_author · 2026-07-02T22:17:16Z

@drewstone drewstone merged commit cedb0d4 into main Jul 2, 2026
1 check passed
@drewstone drewstone deleted the docs/dx-close-small-batch branch July 3, 2026 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants