docs: ENG2 v2 rebuild runbook + perf/test agent rules - #811
Merged
Conversation
…dmap Adds the authoritative v2 rebuild runbook under docs/src/runbook/ (wired into the mdBook): overview, phase index, per-phase specs (0-9), perf definition of done with named scenes S1-S5/H1, testing strategy (unit/isolation/integration/ E2E/spec + story gallery + determinism/fuzz), Throne sync points, and the roadmap issue template. Grounded in a full-engine audit; tracked by the pinned ENG2 master issue (#810) and 102 phase issues. Archives ALPHA_ROADMAP.md with a header correcting the false "v2 Core Performance COMPLETE" claim (#677/#678/#679 were open at the time). Adds agent rules perf-work.md, render-v2.md, testing-v2.md encoding the v2 perf definition of done, O(visible) render invariants, and spec-first/story testing discipline for future /gh-issue agents; points AGENTS.md at the runbook. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Claude finished @aram-devdocs's task in 3m 27s —— View job Review complete ✅Todo list
Verdict: CHANGES REQUESTEDThis is a docs-only PR (no Rust/FFI/SDK code), so Phases 2/3/5 of the standard review (architecture, FFI anti-patterns, security) are N/A. Full review focused on content correctness, mdBook wiring, and the BLOCKERS
WARNINGS
Verified clean
Positive callouts
Recommendation: fix Blocker #1 (strip local paths) before merge; Warnings are non-blocking but #2 (stale issue counts) is worth a quick fix since it's the kind of number someone will cite later. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Add blank lines around tables (MD058) and backtick-wrap _TYPE_ALIASES (MD037); regenerate .cursor/rules/*.mdc mirrors for the three new .agents/rules files (sync-agent-configs). Fixes the Lint Markdown and Validate AI Config Sync checks. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
Commits the authoritative v2 rebuild runbook and the agent-config improvements that back the ENG2 program (master tracking issue #810, 102 phase issues + 7 Throne adoption issues).
What this adds
docs/src/runbook/(wired into the mdBookSUMMARY.md):index.md,phase-index.md, per-phase specsphases/phase-0..9.md, fullphase-specs.md+phase-specs-expansion.mdperf-dod.md— the perf definition of done + named scenes S1–S5/H1 with super-high-FPS targets (120+ FPS, tens of thousands of visible entities, O(visible) not O(total))testing-strategy.md— unit/isolation/integration/E2E/spec tiers, the scene story gallery ("Storybook for the engine"), determinism/property/fuzz, Docker CIthrone-sync.md,issue-template.mdALPHA_ROADMAP.mdwith a header correcting the false "v2 Core Performance COMPLETE" claim..agents/rules/{perf-work,render-v2,testing-v2}.md— perf definition of done, O(visible) render invariants, spec-first/story testing discipline;AGENTS.mdpoints at the runbook.Why
A 12-subsystem, file:line-verified audit found the engine's 1–17 FPS on Throne traces to O(total) per-object render submission and a 3-global-lock / triple-implemented component store, with instrumentation that reported zero. This runbook is the plan to fix it; the issues (#810 and children) are the execution.
Validation
scripts/check-agents-md.shpasses (AGENTS.md 54 lines; no stale patterns)mdbook buildsucceeds with the runbook rendereddocs:-prefixed so release-please cuts no release🤖 Generated with Claude Code