Phase 0: Phase 0 documentation #63

Merged
erikinkinen merged 5 commits from 0-phase0-documentation into main 2026-03-03 14:08:28 +01:00
Owner

Summary

Implements Phase 0 documentation v0 for issue #22 by extending docs/phase0.md in place to make assumptions explicit and reviewable.

Closes #22

What Changed

  • Added a new Phase 0 Assumptions Ledger section near the top of the document.
  • Added a consolidated Invariants and non-goals section with:
    • temporal, structural, determinism, and interface-stability invariants
    • explicit non-goals
    • a short change-discipline policy
  • Added a CLI-first Hello World (Phase 0) section with deterministic aes simulate and aes_metrics command flow plus expected outcomes.
  • Added Extension Points (Phase 1+) with a practical seam checklist:
    • what can extend
    • what must not break
    • required regression checks
  • Added a compact PR checklist for Phase 1+ extensions.
  • Renumbered subsequent sections to keep document structure coherent (Pre-commit hooks and CI sections moved to sections 3 and 4).

Scope / Non-Changes

  • Documentation-only change.
  • No production code, API, schema, or test logic changes.

Validation

  • cmake --build _build
  • ctest --test-dir _build --output-on-failure

Result: all tests passing (29/29).

## Summary Implements **Phase 0 documentation v0** for issue **#22** by extending `docs/phase0.md` in place to make assumptions explicit and reviewable. Closes #22 ## What Changed - Added a new **Phase 0 Assumptions Ledger** section near the top of the document. - Added a consolidated **Invariants and non-goals** section with: - temporal, structural, determinism, and interface-stability invariants - explicit non-goals - a short change-discipline policy - Added a CLI-first **Hello World (Phase 0)** section with deterministic `aes simulate` and `aes_metrics` command flow plus expected outcomes. - Added **Extension Points (Phase 1+)** with a practical seam checklist: - what can extend - what must not break - required regression checks - Added a compact **PR checklist for Phase 1+ extensions**. - Renumbered subsequent sections to keep document structure coherent (`Pre-commit hooks` and `CI` sections moved to sections 3 and 4). ## Scope / Non-Changes - Documentation-only change. - No production code, API, schema, or test logic changes. ## Validation - `cmake --build _build` - `ctest --test-dir _build --output-on-failure` Result: all tests passing (`29/29`).
erikinkinen added this to the Phase 0 milestone 2026-03-03 13:26:11 +01:00
Phase 0: Document extension points for Phase 1+ (#22)
Some checks failed
ci / smoke (push) Successful in 15s
ci / smoke (pull_request) Successful in 15s
clang-format / check-format (pull_request) Successful in 9s
markdownlint / markdown-lint (pull_request) Failing after 9s
clang-format / check-format (push) Successful in 9s
markdownlint / markdown-lint (push) Failing after 10s
dd0fda7e1f
Phase 0: Enhance documentation of assumptions ledger with detailed rationale and verification methods
All checks were successful
ci / smoke (push) Successful in 15s
clang-format / check-format (push) Successful in 9s
markdownlint / markdown-lint (push) Successful in 10s
ci / smoke (pull_request) Successful in 15s
clang-format / check-format (pull_request) Successful in 9s
markdownlint / markdown-lint (pull_request) Successful in 9s
fc0ff08cb4
Sign in to join this conversation.
No reviewers
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
erikinkinen/AES!63
No description provided.