Skip to content

docs: refresh docs to match the now-shipped reality (real swarm, Gold Seal, honest pipeline, live model)#17

Merged
New1Direction merged 1 commit into
mainfrom
docs/honest-refresh
Jun 15, 2026
Merged

docs: refresh docs to match the now-shipped reality (real swarm, Gold Seal, honest pipeline, live model)#17
New1Direction merged 1 commit into
mainfrom
docs/honest-refresh

Conversation

@New1Direction

Copy link
Copy Markdown
Owner

What

Audited the tracked product docs against what's actually on main and applied surgical, honest fixes. Already-accurate docs (korg-registry, korg-embeddings, korg-auth, korg-bridge, korg-seal) were left untouched.

Run as an audit → honest-update → adversarial-critic pipeline against a strict shipped-reality brief, then spot-verified the riskiest edits against source. The agents removed overclaims (invented numbers, stale placeholder claims) as much as they fixed stale ones — fitting for a trust product.

README.md

  • Status rewritten: honest shipped/planned split; 300+ tests (was a stale "175"); the swarm is now listed as a real 5-persona swarm; surfaced the Gold Seal, honest pipeline, live-model, and in-browser verifiers.
  • BERT/Candle made honest (optional candle feature; deterministic fallback otherwise).
  • Comparison gained Gold Seal + honest-attestation rows; added the live-model swarm example + in-browser verifier links; removed the stale "ARCHITECTURE coming soon".

ARCHITECTURE.md

  • 4-persona → 5-persona (added the distinct Persona::Evaluator).
  • New "Verifiable Flight-Recorder Capabilities" section (ledger@v1, Gold Seal, honest run-once, provider model) with a clearly-marked Planned list.

Other docs

  • ROADMAP: removed micro-healing from future work (already shipped).
  • Removed invented numbers (GIT_ISOLATION "<50ms"; POSITIONING "200-line").
  • De-stale'd brittle exact test counts (korg-core, korg-setup) or corrected them to real, counted values (recall-mcp).
  • Documented response_format + DeterministicProvider (korg-llm).
  • Clarified legacy flat ledger vs the recommended verifiable per-session capture (claude-code).
  • Honest "no bundled SPA/WASM frontend" (korg-server); corrected stale placeholder/stub claims that no longer match the code (korg-tui).

Test plan

  • Docs-only change (no code) — every edit audited against source + re-checked by an adversarial honesty critic
  • Spot-verified all numbers are counted, not invented (recall-mcp test counts, TUI placeholder behavior, version strings)
  • CI green on the branch

… Seal, honest pipeline, live model)

Audited the tracked product docs against what is actually on `main` and applied
surgical, honest fixes. Already-accurate docs (korg-registry, korg-embeddings,
korg-auth, korg-bridge, korg-seal) were left untouched.

README.md:
- Status section rewritten: honest shipped/planned split; 300+ tests (was a
  stale "175"); swarm listed as a real 5-persona swarm; surfaced the Gold Seal,
  honest pipeline, live-model and in-browser verifiers.
- BERT/Candle made honest (optional `candle` feature; deterministic fallback).
- Comparison gained Gold Seal + honest-attestation rows; added the live-model
  swarm example + in-browser verifier links; removed stale "ARCHITECTURE coming
  soon".

ARCHITECTURE.md: 4-persona -> 5-persona (added the distinct `Persona::Evaluator`);
new "Verifiable Flight-Recorder Capabilities" section (ledger@v1, Gold Seal,
honest run-once, provider model) with a clearly-marked Planned list.

ROADMAP.md: removed micro-healing from future work (it is already shipped).

Crate/adapter READMEs + docs/: removed invented perf/size numbers
(GIT_ISOLATION "<50ms", POSITIONING "200-line"); de-stale'd brittle exact test
counts (korg-core, korg-setup) or corrected them to the real counts
(recall-mcp); documented `response_format` + `DeterministicProvider`
(korg-llm); clarified legacy flat-ledger vs the recommended verifiable
per-session capture (claude-code); honest "no bundled SPA/WASM frontend"
(korg-server); corrected stale placeholder/stub claims that no longer match the
code (korg-tui).

Each edit was audited against the source and re-checked by an adversarial
honesty critic; spot-verified that all numbers are counted, not invented.
@New1Direction New1Direction merged commit c0233f5 into main Jun 15, 2026
3 checks passed
@New1Direction New1Direction deleted the docs/honest-refresh branch June 15, 2026 10:04
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.

1 participant