Skip to content

docs(accounting-rerun): align accounting and journal contracts - #87

Merged
c-wri merged 7 commits into
mainfrom
docs/accounting-rerun-alignment
Apr 21, 2026
Merged

docs(accounting-rerun): align accounting and journal contracts#87
c-wri merged 7 commits into
mainfrom
docs/accounting-rerun-alignment

Conversation

@c-wri

@c-wri c-wri commented Apr 21, 2026

Copy link
Copy Markdown
Collaborator

Why:

  • forward docs still split accounting ownership, journal backend seams, and rerun guarantees across inconsistent surfaces, which made the target architecture harder to trust and harder to implement cleanly
  • the forward-target validators and docs-audit rules needed to move with the docs so the corrected boundaries stay enforced instead of drifting back

What:

  • align durable docs on accounting as the owning capability, Journal as the canonical accounting product, ledger_cli as the first backend, and deterministic rerun plus fast-path rules
  • route the journal contract through the docs overview, migration, persistence, and workspace references while keeping current-state rebuild validation developer-only
  • split forward-contract docs-audit rules by domain so the enforcement stays reviewable and within repo modularity limits

Checks:

  • make docs-check
  • make naming-check
  • make docs-audit
  • make quality
  • make pr-review

Issue linkage:

  • None: searched open issues and no existing issue matched this docs and docs-audit contract alignment work

Included checkpoints:

  • docs(products): relocate downstream planning into durable docs
  • docs(journal): anchor journal planning to ledger-cli
  • docs(journal): define replaceable backend contract
  • docs(journal): align migration and routing guidance
  • docs(rerun-policy): align deterministic rerun guidance
  • docs(accounting-contracts): align journal ownership model
  • refactor(docs-audit): split forward contract rule domains

c-wri added 7 commits April 20, 2026 15:13
Why:
- the implemented economics, reconciliation, and checkpoint slice still needed an explicit durable-doc handoff so later work would not keep treating downstream completion detail as planning-only context
- the journal branch needed that downstream handoff to land first so the new journal planning would build on the bounded downstream owner docs instead of absorbing that retirement work indirectly

What:
- add explicit implemented-slice routing from the bounded economics, reconciliation, and checkpoint contract to current state, architecture, migration, and workspace placement docs
- tighten the architecture, migration, and product-output docs so the current bounded downstream authorities and retained compatibility views read as durable implemented surfaces
- keep the wording neutral and contract-focused so the completed downstream slice stays documented on durable docs instead of planning-only prose

Checks:
- make docs-check
- make naming-check
- make docs-audit
Why:
- journal planning still pointed to an undefined backend choice, which left the first journal slice without a stable downstream boundary
- the planning anchors needed a durable owner page for the journal contract so later implementation would not have to recover those decisions from planning prose

What:
- rewrite the journal and tax planning anchors around authoritative Journal ownership, ledger_cli as the first backend id, and the no-journal-ref tax boundary
- add the bounded Journal contract page with the replaceable backend seam, backend artifact layout, validation lanes, and replay rules
- sync the docs homepage reference section so the new durable contract is routed with the other target references

Checks:
- make docs-check
- make naming-check
- make docs-audit
Why:
- the journal planning docs still left cross-surface ambiguity around backend ownership, artifact layout, and the tax boundary
- the naming catalog still forced the stale check_id slot on the shared Journal contract surface, which blocked the required entry_check_id contract from validating cleanly

What:
- align the architecture, stage contract, ids, and persistence owner pages around Journal authority, the replaceable journal backend seam, and ledger_cli as the first backend id
- normalize the shared Journal contract surface on entry_check_id and clarify that backend-specific rendering and validation stay outside the backend-neutral kernel
- update the target-naming catalog so the owning docs validator accepts the revised Journal identifier contract

Checks:
- make docs-check
- make naming-check
- make docs-audit
Why:
- the supporting migration and routing docs still left the journal backend cutover implicit even after the owner pages were updated
- the durable journal contract needed to be visible from the main overview and workspace routes so later implementation would not fall back to the retired placeholder model

What:
- align migration and cutover guidance around Journal authority, ledger_cli as the first backend reader, replay from Journal alone, and the no-journal-ref tax boundary
- add the Journal contract to the top-level docs routes and architecture overview with the replaceable backend seam called out directly
- add a target-direction workspace note for planned journal artifact placement without presenting those paths as current runtime fact

Checks:
- make docs-check
- make naming-check
- make docs-audit
Why:
- ordinary product behavior still read too close to replay or rebuild-oriented validation, which left rerun guarantees and the calculation fast path underspecified
- the docs audit rule still required the obsolete replay-gates heading, which blocked the intended contract wording

What:
- define deterministic rerun, calculation fast-path, and safe full-rebuild override policy across planning, migration, engineering, status, and guide surfaces
- reclassify rebuild validation as developer-only and refresh the evidence and economics contract wording plus generated docs home copy
- update the docs-audit rule to require the new idempotent rerun heading on the bounded contract pages

Checks:
- make docs-check
- make naming-check
- make docs-audit
- make quality
Why:
- forward docs still split accounting semantics across retired journal-root package paths and older future-family naming, which left ownership, backend seams, and persistence boundaries inconsistent
- the naming catalog and docs-audit rules needed to move with the owner docs so repo checks protect the corrected architecture instead of the superseded package roots

What:
- align planning, migration, concept, reference, and standards docs on `accounting` as the owning capability and `Journal` as the canonical accounting product
- replace the retired visualization family with performance, update the target naming catalog and docs-audit expectations, and strengthen the catalog test coverage for the new canonical package set
- define the accounting backend seam, bounded `ledger-cli` operations, durable versus on-demand artifacts, and backend-storage boundaries in the journal and persistence references

Checks:
- make docs-check
- make naming-check
- make docs-audit
- make quality
Why:
- the forward-contract docs-audit rules had grown into oversized catch-all modules, which violated the repo's refactor expectations and made the new journal-contract checks harder to maintain
- the red-team loop also needed the editor-facing rule modules and the repo runners to agree on imports, line lengths, and forward-target classification updates

What:
- split the forward-contract docs-audit rules into foundations, evidence-claim, reconciliation-checkpoint, boundary, and journal modules and update the docs-audit catalog to load the new rule sets
- keep the accounting boundary, rerun policy, and journal contract review checks aligned while removing the current-state workspace planning leak
- keep the forward-target naming and docs-audit classifiers aligned with the accounting, performance, and journal contract surfaces

Checks:
- make docs-check
- make naming-check
- make docs-audit
- make quality
- make pr-review
@c-wri
c-wri marked this pull request as ready for review April 21, 2026 07:01
@c-wri
c-wri enabled auto-merge April 21, 2026 07:01
@c-wri
c-wri merged commit 33b1715 into main Apr 21, 2026
68 of 84 checks passed
@c-wri
c-wri deleted the docs/accounting-rerun-alignment branch April 21, 2026 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant