alkstore/tasks/release-readme.md at 5f5f6741d5dae839d6b62b442e2c62f6a865df99

0 Fork 0

Files

T

glm-5.3-flash 9e069ced59 wave-8 decomposition — the release-readiness pass: eleven tasks (seven independent entries: frontmatter cleanup — 11 docs with invalid YAML frontmatter, the renumber sweep, crate docs, the class-1 window's last dispositions, N-1, Findings 2-3, the fired-trigger flake investigation; then deployment matrix -> README -> publish prep -> review-wave-8 gate); plan wave-8 row + task set + review-rounds entry

2026-10-10 23:10:22 +00:00

3.4 KiB

Raw Blame History

id, name, status, depends_on, scope, risk, impact, level, tags

name

status

depends_on

scope

risk

impact

level

Description

The plan's wave-8 "crate README (written last, honestly)" — the root README.md does not exist yet, and it is written last so it describes the shipped thing, not the intended one. Its dependencies are the wave's other doc-shaped tasks for exactly that reason.

README.md (root, the crates.io-facing front page): what alkstore is (one reactive store interface — notify, streams, queues, locks, scheduler, outbox — over SQLite, Postgres, and the in-process mem engine), the crate family table (which crate to pick, per ADR-016's compile-time engine identity), the honest posture lines per engine (single-host file-backed / multi-host / honest-ephemeral, never fleet-valid), a minimal usage sketch (compile-checked against the real API — the mem engine is the zero-config example carrier), the contract-suite pointer (three engines, one pinned contract), and the license note. No aspirational claims: only what waves 1–7 shipped.
LICENSE files: LICENSE-MIT + LICENSE-APACHE at the root per the family pattern (alkcall/alksocks ship both; the workspace license = "MIT OR Apache-2.0" field is set but no license files exist). The substrate's in-tree dual-license notice (ADR-018) stays as landed — the root files do not replace it.
CHANGELOG.md: seeded per the family pattern — the 0.1.0 initial-release entry summarizing the contract v1 surface and the three engines (honest, brief; the family's changelogs are release-note-shaped, not commit logs).
Per-crate readme wiring: decide whether each published crate's [package] readme points at the root README or gets its own short crate-specific readme (the engines' lib docs already carry their posture — a pointer-style per-crate readme is the likely honest shape); land the decision.
Honesty cross-check: every README claim traceable to a spec (core-contract.md, deployment.md, the engine specs) — this is the "written last, honestly" discipline, and the review gate will audit it.

Acceptance Criteria

Root README.md exists: family table, per-engine honest postures, compile-checked usage sketch, suite pointer, license note; no aspirational/unshipped claims
LICENSE-MIT + LICENSE-APACHE at the root (MIT + Apache-2.0 canonical texts); ADR-018's in-tree substrate notice untouched
CHANGELOG.md seeded with the 0.1.0 entry
The per-crate readme wiring decided + landed
Every README claim traceable to a spec (the trace list in Notes)
Workspace gates green (docs-only expected)

References

docs/plans/implementation.md §Wave 8 (written last, honestly)
docs/architecture/overview.md (the family/feature source)
docs/architecture/deployment.md (the posture lines)
docs/architecture/decisions/016-deployment-honesty.md, docs/architecture/decisions/018-provenance-register-and-cherry-picks.md
/workspace/@alkdev/alkcall/README.md + CHANGELOG.md (the family pattern)

Notes

To be filled by implementation agent

Summary

To be filled on completion

3.4 KiB Raw Blame History Unescape Escape