docs: operations sweep, delete dated reports and trim runbooks - #604
Merged
Conversation
Delete every point-in-time artefact (load, backtest, baseline, and e2e report snapshots, the m3 edge-case validation write-up, and the e2e run-prep punch list) so no dated result crosses the carve. Trim the five runbooks (m2, m3, e2e, load, soak) to repeatable numbered steps: cut motivation, milestone scheduling, grant-evidence framing, and result commentary, and purge em dashes. Salvage the reusable UID and ComposableCoW calldata re-derivation recipes from the deleted e2e-prep into the e2e runbook. Align the engine run commands to the shepherd binary the just recipes and load-run.sh invoke, and trim the e2e report template to its fields. Part of #598.
Hard-wrapped prose churns diffs: a one-word edit reflows the whole paragraph. Join each paragraph onto a single logical line and let it soft-wrap. Content unchanged (word and heading counts preserved); code fences, tables, lists, blockquotes and headings untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Cruft-sweep of
docs/operations/for the #598 umbrella.Deleted the dated point-in-time artefacts so no snapshot crosses the carve: the load reports (5x5, 20x20, 50x50, 50x50-parallel), the 7-day backtest report, the latency baseline, the 2026-06-18 e2e report, the m3 edge-case validation write-up, and the e2e run-prep punch list.
Trimmed the five runbooks (m2, m3, e2e, load, soak) and the e2e report template to repeatable steps and fields: cut motivation, milestone scheduling, grant-evidence framing, and result commentary, and purged em dashes.
Salvaged the reusable OrderUid and ComposableCoW calldata re-derivation recipes out of the deleted e2e-prep and into the e2e runbook before deleting it.
Fixed drift: the engine run commands now use the
shepherdbinary that thejustrecipes andscripts/load-run.shactually invoke, the m3 SDK-helper reference points atcrates/nexum-sdk/src/chain/, and the report template's ERROR-line check namesnexum_runtime.Area went from 4843 lines across 15 files to 768 across 6.
Why
The operations tree triple-covered procedures with dated results and planning prose. Runbooks are repeatable procedures and stay (trimmed); dated reports are snapshots and go.
Testing
Documentation-only sweep; markdown-only area, so no build. Verified the
shepherd_*metric names, engine config paths, module names (stop-loss and the rest still present undermodules/examples/), tools (orderbook-mock,load-gen), and the run binary against the tree at /code/nxm/runtime; confirmed no surviving doc links to any deleted file and no em dashes remain.AI Assistance
Documentation-only sweep; verification described under Testing.
Part of #598.