Skip to content

V2.10.S7: Evidence, documentation, and release closure #58

Description

@deeprnd

V2.10.S7: Evidence, documentation, and release closure

Status: Backlog
Epic: #[github-epic-issue]
Parent roadmap item: V2.10: Build System Consolidation And Qt Build Validation
Labels: type/story, type/documentation

Collect all evidence that V2.10 is complete, update documentation, and perform
the quality gate closure. This is the closure story — all other stories must be
done before this one starts.

Product Outcome

The epic is demonstrably complete: documentation reflects the final recipe names
and workflow, all evidence is collected, quality gates pass, and the roadmap
accurately reflects the shipped scope and non-goals.

User Story

As a reviewer or new contributor, I can read the updated documentation and run
just setup && just build-all && just test-unit-all && just build-tkni on a
clean checkout to verify the consolidated build surface works end-to-end.

Scope

  • In scope: collect evidence from all 6 preceding stories (S1–S6).
  • In scope: update doc/execution/build.md:
    • Add the just installation prerequisite note.
    • Document setup-* recipes and the "zero to green" flow.
    • Document the fully-qualified naming grid.
    • Document build-tkni / test-tkni for Qt terminal.
  • In scope: update doc/execution/development.md:
    • Prerequisites section: replace "install these tools yourself" with
      "run just setup".
    • Useful current commands list updated with new recipe names.
  • In scope: update doc/execution/ci.md:
    • Zig Toolchain Policy: collapse to one install path (install-zig.py).
    • Describe setup-* as the entrypoint that wraps it.
    • Update workflow tables to show fully-qualified recipe names.
  • In scope: update doc/execution/testing-tickoni.md:
    • Test command matrix with new fully-qualified names.
    • Include cross-platform test-unit-fd-{os}-{arch} entries.
    • Note that CI does not schedule macOS/Windows variants (D5).
  • In scope: update doc/execution/contribution/tickoni.md:
    • If it documents the build-fd-*/test-* naming, extend it to state the
      {command}-{os}-{arch}[-{compiler}] grid as a rule for new recipe families.
  • In scope: update V2.10 epic file to mark all stories as Done.
  • In scope: update doc/strategy/README.md if the epic index needs a new entry.
  • In scope: run just quality-check-all and just security-check-all (or
    equivalent) on the final state and record results.
  • In scope: update epic acceptance in doc/strategy/roadmap/epics/v2.10.md.

Preconditions And Assumptions

  • S1–S6 are all Done.
  • The build-tooling-consolidation.md and build-zig-refactor.md proposals are
    the source documents for this epic.

Acceptance Criteria

  • Given the updated doc/execution/build.md, when a new contributor reads
    it, then they find: (1) install just as the sole manual prerequisite,
    (2) just setup to install dependencies, (3) just build-all and
    just test-unit-all to build and test, (4) just build-tkni for Qt.
  • Given the updated doc/execution/development.md, when the Prerequisites
    section is read, then it points to just setup instead of listing
    individual tool installs.
  • Given the updated doc/execution/ci.md, when a CI workflow author reads
    the Zig Toolchain Policy, then they find one Zig install path and the
    fully-qualified recipe naming convention.
  • Given the updated doc/execution/testing-tickoni.md, when a test author
    reads the test command matrix, then they find the new fully-qualified
    names including test-unit-fd-{os}-{arch} entries with a note about D5.
  • Given the updated doc/execution/contribution/tickoni.md, when a
    contributor reads the naming convention section, then they find the
    {command}-{os}-{arch}[-{compiler}] grid rule.
  • V2.10 epic file has all 7 stories marked Done.
  • Epic acceptance in v2.10.md is updated with final evidence.
  • just quality-check-all and just security-check-all pass.
  • build.zig is confirmed <500 lines.
  • Qt terminal builds and launches (just build-tkni succeeds).
  • Platform detection lives in contrib/platform.sh — no remaining inline
    uname -s/uname -m in justfile or in-repo scripts.
  • All deleted scripts are confirmed absent from the repo.
  • CI workflows use fully-qualified recipe names (verified by scanning
    .github/workflows/).

Conditional Acceptance

Financial capability and policy

  • N/A - story updates documentation; no policy changes.

Audit and replay

  • N/A - story updates documentation; no audit/replay changes.

Runtime topology and tile ownership

  • N/A - story updates documentation; no topology changes.

Model, tool, adapter, or execution boundary

  • N/A - story updates documentation; no model/adapter/execution changes.

CaseOps API or UI

  • N/A - story updates documentation; no API/UI changes.

Storage role: Memory, Analytics, Ledger

  • N/A - story updates documentation; no storage changes.

Metrics, diagnostics, and operations

  • N/A - story updates documentation; no metrics/telemetry changes.

Security and fail-closed behavior

  • Given just security-check-all, when it runs on the final state, then
    it passes with no new findings introduced by the build system changes.

Evidence Plan

  • Demo or command: just setup && just build-all && just test-unit-all && just test-integration-tk && just test-tkni (if available) on a clean checkout.
  • Tests: All CI lanes pass with fully-qualified recipe names.
  • Fixtures or samples: Updated documentation files.
  • Audit/replay evidence: N/A - build system only.
  • Blocked-flow evidence: N/A - closure story.

Quality Gate

  • All 7 stories are Done.
  • Documentation is consistent across build.md, development.md,
    ci.md, testing-tickoni.md, and contribution/tickoni.md.
  • build.zig <500 lines confirmed.
  • Qt build succeeds.
  • just quality-check-all and just security-check-all pass.
  • Epic file updated.
  • No deleted scripts referenced anywhere in docs.

Notes And Open Questions

  • None — this is the closure story.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type/documentationImprovements or additions to documentationtype/storySingle implementable deliverable that can be independently verified

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions