Skip to content

Refresh segment-store v1 living documentation after recovery delivery #69

Description

@flyingrobots

Problem

The living keep.segment-store/v1 reference still describes merged initialization and recovery work as future or incomplete:

Issues #16 and #17 are complete on main. The current-behavior reference therefore understates shipped guarantees and gives v2 migration work a stale source boundary.

Priority

P2 — should fix. This is not a current data-integrity defect, but it can misdirect implementation and review of the v1-to-v2 migration.

Dependencies

Depends on completed issues #16 and #17. It does not block issue #19, but should close during M4 before the v2 documentation becomes the primary format route.

Acceptance criteria

  • Every living v1 format page describes current main behavior rather than completed issue-era plans.
  • Historical scope remains available through linked issues, ADRs, and Git history without posing as current truth.
  • Claims are reconciled against implemented initialization, platform admission, publication, restart, and recovery evidence.
  • Existing requirement identifiers and concrete tests remain the evidence anchors.
  • Documentation refusal, integrity, link, and whitespace gates pass.

Non-goals

  • Changing the v1 byte format.
  • Implementing v2 retention.
  • Reorganizing unrelated documentation.

No activity

Activity on this issue will appear here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:formatCanonical durable formats and decodingarea:recoveryCrash states, reconciliation, and recoverydocumentationImprovements or additions to documentationpriority:P2Should fix

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions