Skip to content

docs: make the README a front door - #122

Merged
Sannrox merged 1 commit into
mainfrom
docs/121
Nov 5, 2026
Merged

Sannrox merged 1 commit into
mainfrom
docs/121

Conversation

@Sannrox

@Sannrox Sannrox commented Nov 5, 2026

Copy link
Copy Markdown
Owner

Closes #121.

What changes

Restructures README.md into the family front-door shape while keeping every existing fact:

  • Bolded one-line pitch, CI/Release/License badges, and a link row to real files (Try it, CLI, engine bar, streaming jobs, decisions).
  • The status blockquote stays verbatim, unsoftened.
  • A plain-words paragraph (name meaning plus what the runner does) and six benefit bullets derived from documented capabilities.
  • A verified ## Try it: clone, cargo test --locked --workspace, kako doctor. Output blocks are pasted from runs executed in the lane worktree on a non-Linux host; sandboxed runs are labeled Linux-only and the observed fail-closed message is shown instead of fabricated success output.
  • ## How it works: a mermaid flowchart of the real run mechanism (job source, staging, kekkai sandbox, outputs, receipt, cleanup), a concepts paragraph, and a "Why not a workflow orchestrator?" paragraph backed by ADR 0002/0004/0007/0009. It replaces the numbered list and ASCII diagram; all their facts moved into it.
  • The CLI wall of text gains subsections (Run a job / Validate and preview / Replay / Serve and drain) with the prose unchanged.
  • Development now points at AGENTS.md and the decisions index.

Lane: claim branch docs/121, worktree .worktrees/issue-121, base e70f72c5c5083a091edb09ee3a267ea38f55a4c4, published 822ac4a286045c91edc4d2dd825581812c201981.

Tests run

  • cargo test --locked --workspace: all suites ok, 0 failed (ignored tests are the documented external-prerequisite ones).
  • cargo run --locked -p kako -- doctor and a sample kako run on a non-Linux host: outputs observed and pasted into Try it.
  • bash scripts/validate-workflow-skills.sh: passed.
  • Relative-link check over README: all targets exist.

Review

Docs-only change; structured review waived per the delivery-closeout policy.

Agent Transcript

Goal: apply the family front-door README style and repo metadata to kako (#121).

Key decisions:

  • Based the rewrite on the branch tip README (streaming jobs v1, validate/preview/replay, markings, encryption, scoring), not an older local copy.
  • Scoped Try it to what genuinely runs on a dev host: offline tests plus doctor; showed the fail-closed run message rather than pretending a sandboxed run works everywhere.
  • Kept the status blockquote and all substantive sections; restructured only.

Changes made: README.md rewritten in place; no behavior, CLI, or ADR changes.

Verification: workspace tests green in the lane worktree; doctor/run outputs observed before pasting; validate-workflow-skills.sh passed; every relative link resolves; a line-by-line diff audit confirmed the only deletions are the replaced intro, numbered list, and ASCII diagram.

Skipped-deferred: no CHANGELOG entry (docs restructure, no user-visible behavior change); autoreview waived as docs-only.

🤖 Generated with Claude Code

Restructure the README into the family front-door shape: one-line pitch,
CI/Release/License badges, a link row, benefit bullets, a verified Try it
section scoped to what runs on a non-Linux dev host, and a mermaid diagram
of the run mechanism. All prior facts stay; the CLI wall of text gains
subsections. Closes #121.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Sannrox
Sannrox marked this pull request as ready for review November 5, 2026 16:58
@Sannrox
Sannrox merged commit d271e38 into main Nov 5, 2026
6 checks passed
@Sannrox
Sannrox deleted the docs/121 branch November 5, 2026 18:10
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.

docs: make the README a front door

1 participant