Skip to content

v0.3.161 - README Restructure

Choose a tag to compare

@mow-coding mow-coding released this 03 Jul 10:57

v0.3.161 - README Restructure

v0.3.161 is a docs-only release. It restructures the two root READMEs
(README.md
and
README.ko.md),
which had accreted one append per release for roughly 160 releases: a 49-line
"Earlier public baseline" ladder in Status, "What exists today" bullets that
had grown into 1,600-3,900-character run-on sentences, and a ~200-tag release
list in Versioning. No CLI, MCP, schema, or archive behavior changes.

What Changed

  • Status now carries only: the current-baseline code block
    (v0.3.161 pre-release), ONE previous-baseline line, and a single "Full
    release history" pointer to CHANGELOG.md and wom-kit/docs/releases/. The
    roadmap-snapshot paragraph and the not-production-ready sentence are
    unchanged. The 49-line baseline ladder is deleted.
  • "What exists today" became a "What Exists Today" section with nine thematic
    subsections: Archive core & lifecycle; Capture & intake; Retrieval & views;
    Sharing & ZET previews; Privacy & redaction; AI-operator contracts &
    runtime handoff; Provider integrations (Tiro / Notion / zettel edge writes /
    object storage / IMAP); Credentials & setup guidance; Hygiene & release
    tooling. The four monster bullets (credentials, Notion/export, IMAP, objet
    links) were decomposed into short single-capability bullets. Every claim
    from the old bullets survives (the claim-by-claim mapping is recorded with
    the v0.3.161 decision log), and the section keeps its single pointer to the
    WOM-kit Capability Matrix for the status-by-capability view.
  • "What does not exist yet" became "What Does Not Exist Yet" with the same
    eleven one-line bullets; no non-goal claims were dropped.
  • Versioning keeps its two intro sentences and now states the current
    checkpoint tag, that every release is tagged, and where the full tag
    history lives (CHANGELOG.md, VERSIONING.md, and the GitHub releases page),
    plus one compact paragraph naming the checkpoint baselines that earlier
    release notes and upgrade guides still reference. The per-line tag list is
    deleted.
  • README.ko.md received the same structure as a real Korean rendition in the
    existing document's voice, not a machine-literal translation.

Maintenance Contract

To prevent re-accretion, v0.3.161 adopts a README maintenance contract,
recorded in the v0.3.161 decision log and as an HTML comment at the top of
each README's Status section: per release, update ONLY (1) the
current-baseline line, (2) the one previous-baseline line, and (3) for
feature releases, at most ONE thematic bullet under "What Exists Today".
Release history lives in
CHANGELOG.md
and the
release notes directory,
not in the READMEs.

Safety Boundary

  • Docs-only: no new write path, no MCP tool, no provider call, and no schema
    change. The version bump touches the usual three version files only.
  • All test-pinned README substrings (baseline strings, capability-bullet
    fragments, pinned doc links, and the v0.2.5x tag ordering) survive the
    restructure verbatim; the doc test suite passes unchanged.

Still Future

  • No README content automation; the maintenance contract is a documented
    human/agent rule, not an enforced tool gate.

Verification

cd wom-kit
python -m unittest discover -s tests
python tools/check_release_readiness.py

Upgrade Notes

No archive migration is required. Nothing changes for JSON consumers. If a
script scraped the deleted README baseline ladder or the Versioning tag list,
point it at CHANGELOG.md, VERSIONING.md, or git tag instead.