@reicek/neataptic-ts 0.1.26 → 0.1.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/.github/agents/boundary-mapper.agent.md +13 -8
  2. package/.github/agents/docs-scout.agent.md +14 -9
  3. package/.github/agents/plan-scout.agent.md +11 -6
  4. package/.github/agents/solid-split.agent.md +33 -17
  5. package/.github/copilot-instructions.md +100 -88
  6. package/.github/skills/educational-docs/SKILL.md +90 -40
  7. package/.github/skills/educational-docs/assets/mermaid-diagram-playbook.md +141 -141
  8. package/.github/skills/educational-docs/assets/visual-style-guide.md +1 -1
  9. package/.github/skills/plan-alignment/SKILL.md +1 -1
  10. package/.github/skills/solid-split/SKILL.md +54 -35
  11. package/.github/skills/solid-split/assets/docs-checklist.md +1 -1
  12. package/.github/skills/solid-split/assets/split-plan-template.md +41 -12
  13. package/.github/skills/solid-split/assets/split-workflow-checklist.md +4 -1
  14. package/.github/skills/test-fix-workflow/SKILL.md +12 -7
  15. package/.github/skills/trace-analyzer-extension/SKILL.md +1 -1
  16. package/.github/skills/trace-analyzer-extension/assets/extension-checklist.md +1 -1
  17. package/.github/skills/trace-analyzer-extension/references/analyzer-extension-workflow.md +1 -1
  18. package/.github/skills/trace-audit-reporting/SKILL.md +1 -1
  19. package/.github/skills/trace-audit-reporting/assets/performance-report-template.md +1 -1
  20. package/.github/skills/trace-audit-reporting/references/trace-analysis-workflow.md +1 -1
  21. package/.github/skills/tracker-handoff/SKILL.md +53 -5
  22. package/package.json +1 -1
  23. package/plans/Flappy_Bird_Folder_Documentation_Pass.logs.md +42 -0
  24. package/plans/Flappy_Bird_Folder_Documentation_Pass.md +22 -104
  25. package/plans/README.md +6 -2
  26. package/plans/Roadmap.md +35 -31
  27. package/plans/analyze-trace-solid-split.logs.md +35 -0
  28. package/plans/analyze-trace-solid-split.plans.md +21 -52
  29. package/plans/architecture-solid-split.logs.md +44 -0
  30. package/plans/architecture-solid-split.plans.md +20 -653
  31. package/plans/asciiMaze-typescript-repair.logs.md +35 -0
  32. package/plans/asciiMaze-typescript-repair.plans.md +30 -36
  33. package/plans/generate-docs-solid-split.logs.md +36 -0
  34. package/plans/generate-docs-solid-split.plans.md +21 -73
  35. package/plans/methods-docs.logs.md +37 -0
  36. package/plans/methods-docs.plans.md +22 -183
  37. package/plans/methods-solid-split.logs.md +41 -0
  38. package/plans/methods-solid-split.plans.md +23 -65
  39. package/plans/neat-docs.logs.md +38 -0
  40. package/plans/neat-docs.plans.md +21 -63
  41. package/plans/neat-test-surface-repair.logs.md +38 -0
  42. package/plans/neat-test-surface-repair.plans.md +24 -24
  43. package/plans/readme-first-section-pass.logs.md +63 -0
  44. package/plans/readme-first-section-pass.plans.md +42 -0
  45. package/plans/render-docs-html-solid-split.logs.md +36 -0
  46. package/plans/render-docs-html-solid-split.plans.md +20 -54
  47. package/plans/src-no-explicit-any-cleanup.logs.md +39 -0
  48. package/plans/src-no-explicit-any-cleanup.plans.md +23 -161
  49. package/plans/utils-docs.logs.md +37 -0
  50. package/plans/utils-docs.plans.md +20 -35
  51. package/src/README.md +88 -22
  52. package/src/architecture/README.md +94 -17
  53. package/src/architecture/activationArrayPool/README.md +53 -0
  54. package/src/architecture/activationArrayPool/activationArrayPool.ts +53 -0
  55. package/src/architecture/layer/README.md +94 -5
  56. package/src/architecture/layer/layer.ts +94 -5
  57. package/src/architecture/network/README.md +85 -14
  58. package/src/architecture/network/activate/README.md +301 -213
  59. package/src/architecture/network/activate/docs.order.json +9 -0
  60. package/src/architecture/network/activate/network.activate.utils.ts +90 -0
  61. package/src/architecture/network/connect/README.md +80 -3
  62. package/src/architecture/network/connect/docs.order.json +9 -0
  63. package/src/architecture/network/connect/network.connect.utils.ts +79 -0
  64. package/src/architecture/network/deterministic/README.md +96 -12
  65. package/src/architecture/network/deterministic/docs.order.json +10 -0
  66. package/src/architecture/network/deterministic/network.deterministic.utils.ts +90 -0
  67. package/src/architecture/network/evolve/README.md +286 -228
  68. package/src/architecture/network/evolve/docs.order.json +11 -0
  69. package/src/architecture/network/evolve/network.evolve.utils.ts +59 -0
  70. package/src/architecture/network/gating/README.md +58 -16
  71. package/src/architecture/network/gating/docs.order.json +9 -0
  72. package/src/architecture/network/gating/network.gating.utils.ts +43 -0
  73. package/src/architecture/network/genetic/README.md +75 -36
  74. package/src/architecture/network/genetic/docs.order.json +10 -0
  75. package/src/architecture/network/genetic/network.genetic.utils.ts +53 -17
  76. package/src/architecture/network/network.ts +91 -46
  77. package/src/architecture/network/standalone/README.md +309 -285
  78. package/src/architecture/network/standalone/docs.order.json +13 -0
  79. package/src/architecture/network/standalone/network.standalone.utils.ts +51 -28
  80. package/src/architecture/network.ts +94 -17
  81. package/src/architecture/nodePool/README.md +53 -0
  82. package/src/architecture/nodePool/nodePool.ts +53 -0
  83. package/src/methods/README.md +80 -34
  84. package/src/methods/methods.ts +80 -34
  85. package/src/methods/mutation/README.md +39 -93
  86. package/src/methods/mutation/mutation.ts +58 -0
  87. package/src/multithreading/README.md +114 -14
  88. package/src/multithreading/docs.order.json +5 -0
  89. package/src/multithreading/multi.ts +103 -7
  90. package/src/multithreading/types.ts +6 -1
  91. package/src/multithreading/workers/README.md +72 -2
  92. package/src/multithreading/workers/browser/README.md +39 -0
  93. package/src/multithreading/workers/browser/testworker.ts +40 -0
  94. package/src/multithreading/workers/node/README.md +50 -11
  95. package/src/multithreading/workers/node/docs.order.json +4 -0
  96. package/src/multithreading/workers/node/testworker.ts +43 -3
  97. package/src/multithreading/workers/workers.ts +36 -1
  98. package/src/neat/README.md +230 -152
  99. package/src/neat/adaptive/core/README.md +99 -42
  100. package/src/neat/adaptive/core/adaptive.core.ts +71 -14
  101. package/src/neat/adaptive/core/docs.order.json +8 -0
  102. package/src/neat/docs.order.json +9 -0
  103. package/src/neat/lineage/README.md +118 -16
  104. package/src/neat/lineage/lineage.ts +115 -13
  105. package/src/neat/neat.defaults.constants.ts +91 -13
  106. package/src/neat.ts +86 -20
  107. package/src/utils/README.md +71 -21
  108. package/src/utils/memory.ts +69 -19
  109. package/test/examples/asciiMaze/browser-entry/README.md +81 -8
  110. package/test/examples/asciiMaze/browser-entry/browser-entry.ts +81 -8
  111. package/test/examples/asciiMaze/dashboardManager/README.md +68 -4
  112. package/test/examples/asciiMaze/dashboardManager/dashboardManager.ts +68 -4
  113. package/test/examples/asciiMaze/evolutionEngine/README.md +1259 -1174
  114. package/test/examples/asciiMaze/evolutionEngine/docs.order.json +10 -0
  115. package/test/examples/asciiMaze/evolutionEngine/evolutionEngine.types.ts +87 -0
  116. package/test/examples/asciiMaze/mazeMovement/README.md +81 -4
  117. package/test/examples/asciiMaze/mazeMovement/mazeMovement.ts +81 -4
  118. package/test/examples/flappy_bird/browser-entry/README.md +64 -21
  119. package/test/examples/flappy_bird/browser-entry/browser-entry.ts +64 -21
  120. package/test/examples/flappy_bird/flappy-evolution-worker/README.md +98 -10
  121. package/test/examples/flappy_bird/flappy-evolution-worker/flappy-evolution-worker.ts +98 -10
  122. package/test/examples/flappy_bird/simulation-shared/README.md +88 -4
  123. package/test/examples/flappy_bird/simulation-shared/simulation-shared.types.ts +88 -4
@@ -129,4 +129,4 @@ Good reasons to extend it:
129
129
  Poor reasons to extend it:
130
130
 
131
131
  - one-off formatting preference,
132
- - data that can already be inferred from the existing sections.
132
+ - data that can already be inferred from the existing sections.
@@ -12,8 +12,9 @@ Use this skill when work needs durable continuity in markdown tracker files.
12
12
 
13
13
  This skill is the canonical workflow for `.plans.md` and `.logs.md` structure in
14
14
  NeatapticTS. It owns the tracker status markers, compression rules for old work,
15
- and the required `Handoff query` section that makes WIP sessions safe to resume
16
- with a simple copy-paste prompt.
15
+ the required `Handoff query` section that makes WIP sessions safe to resume
16
+ with a simple copy-paste prompt, and the terminal closure rule for finished
17
+ plans.
17
18
 
18
19
  Other skills may decide when a tracker should be updated, but they should defer
19
20
  the tracker shape itself to this skill instead of redefining status markers,
@@ -38,6 +39,22 @@ handoff layout, or history-compression rules ad hoc.
38
39
  - Use `.logs.md` for compressed done-state records and completed work that no
39
40
  longer needs active session guidance.
40
41
 
42
+ ### Completion Closure Rule
43
+
44
+ When a workstream becomes fully complete, the final tracker step is always to
45
+ close it deliberately.
46
+
47
+ - Compress the completed `.plans.md` file into a short closed tracker that
48
+ preserves only the durable reopen-point context.
49
+ - Add or update a same-boundary `.logs.md` file with the durable done-state
50
+ record.
51
+ - Remove active-session scaffolding that no longer applies, especially stale
52
+ `Remaining gaps`, `Next step`, or `Handoff query` sections.
53
+ - Do not preserve or emit a next-session handoff prompt on a fully closed plan
54
+ unless the user explicitly asks for reopen guidance.
55
+ - If there is still a real next step from the plan's own context, the plan is
56
+ not closed yet and should stay active with a `Handoff query`.
57
+
41
58
  ### Status Markers
42
59
 
43
60
  Every durable tracker should use the same three states:
@@ -71,14 +88,17 @@ The section should:
71
88
 
72
89
  Preferred shape:
73
90
 
74
- ```md
91
+ ````md
75
92
  ## Handoff query
76
93
 
77
94
  ```text
78
95
  Continue from the current repo state only. Do not rely on prior chat history.
79
96
  <workstream-specific continuation prompt>
80
97
  ```
81
- ```
98
+ ````
99
+
100
+ Closed `.plans.md` files should normally omit `Handoff query` because the plan
101
+ has no in-context follow-up step left to hand off.
82
102
 
83
103
  ### Compression Rules
84
104
 
@@ -90,6 +110,13 @@ When a tracker grows too long:
90
110
  - remove repetitive validation transcripts once the result is captured,
91
111
  - prefer concise extent statements over narrative replay.
92
112
 
113
+ When a plan reaches terminal `[DONE]` state:
114
+
115
+ - compress the plan before considering the workstream finished,
116
+ - add or refresh the same-boundary `.logs.md` audit record,
117
+ - keep a short closed tracker focused on scope, final state, audit summary,
118
+ reopen conditions, and the audit-log pointer.
119
+
93
120
  Good completed note:
94
121
 
95
122
  - `[DONE] Runtime diagnostics moved to runtime chapter; Network now delegates DropConnect, dropout reset, and training-health readers.`
@@ -120,6 +147,18 @@ For most `.plans.md` files, prefer this shape:
120
147
  Not every plan needs every section, but active plans should remain compact,
121
148
  forward-looking, and resumable.
122
149
 
150
+ ## Recommended Closed Plan Shape
151
+
152
+ For terminally closed `.plans.md` files, prefer this shape:
153
+
154
+ 1. `# <Workstream name>`
155
+ 2. `**Status:** [DONE]`
156
+ 3. `## Scope`
157
+ 4. `## Final state`
158
+ 5. `## Audit summary`
159
+ 6. `## Reopen conditions`
160
+ 7. `## Audit log`
161
+
123
162
  ## Recommended Log Shape
124
163
 
125
164
  For `.logs.md` files, prefer:
@@ -128,6 +167,8 @@ For `.logs.md` files, prefer:
128
167
  2. `**Status:** [DONE]` or `[WIP]` when still accumulating done-state records
129
168
  3. short done-state entries grouped by durable milestone
130
169
  4. no active TODO list unless the file is intentionally dual-purpose
170
+ 5. the same boundary as the closed `.plans.md` file whenever the workstream is
171
+ complete
131
172
 
132
173
  ## Guardrails
133
174
 
@@ -138,6 +179,10 @@ For `.logs.md` files, prefer:
138
179
  - Do not bury the next-session continuation prompt in prose.
139
180
  - Do not leave a `.plans.md` file without a `Handoff query` section when the
140
181
  workstream is still active.
182
+ - Do not mark a workstream `[DONE]` and stop before compressing the plan and
183
+ adding or updating the same-boundary `.logs.md` file.
184
+ - Do not leave a stale `Handoff query` on a fully closed plan unless the user
185
+ explicitly wants reopen guidance.
141
186
  - Do not preserve detailed historical narration when compact coverage notes are
142
187
  enough to prevent re-exploration.
143
188
  - Do not rewrite generated README files just to record progress; use trackers.
@@ -150,4 +195,7 @@ A strong tracker update should report:
150
195
  - whether it is now `[PLANNED]`, `[WIP]`, or `[DONE]`,
151
196
  - what historical content was compressed,
152
197
  - what the new active frontier is,
153
- - whether a `Handoff query` section was added or refreshed.
198
+ - whether a `Handoff query` section was added, refreshed, or intentionally
199
+ removed because the plan was terminally closed,
200
+ - whether a same-boundary `.logs.md` file was added or refreshed.
201
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reicek/neataptic-ts",
3
- "version": "0.1.26",
3
+ "version": "0.1.27",
4
4
  "description": "Architecture-free neural network library with genetic algorithm implementations",
5
5
  "main": "./dist/neataptic.js",
6
6
  "module": "./dist/neataptic.js",
@@ -0,0 +1,42 @@
1
+ # Flappy Bird Folder Documentation Pass Log
2
+
3
+ **Status:** [DONE]
4
+
5
+ ## Audit scope
6
+
7
+ - Objective: raise the educational quality of the Flappy Bird folder README
8
+ openings without hand-editing generated README output.
9
+ - The pass covered the root-to-leaf reading path across the example's trainer,
10
+ simulation, worker, and browser-entry documentation surfaces.
11
+
12
+ ## Durable milestones
13
+
14
+ ### [DONE] Folder inventory and route closure
15
+
16
+ - Reviewed the tracked Flappy Bird README-owning folders explicitly rather than
17
+ treating the example as a single coarse documentation surface.
18
+ - Closed the reading route from the example root through the system chapters so
19
+ a new reader can follow training, simulation, and browser playback flow.
20
+
21
+ ### [DONE] Source-owned intro remediation
22
+
23
+ - Strengthened the chapter openings that needed better source-owned framing.
24
+ - Corrected generated intro ownership with targeted `docs.order.json` controls
25
+ where a types shelf or weak facade was producing the wrong opening.
26
+
27
+ ### [DONE] Worker and browser-entry documentation alignment
28
+
29
+ - Fixed worker-boundary and browser-entry framing so the generated docs better
30
+ explain host/runtime/message ownership instead of just listing symbols.
31
+
32
+ ## Controls and evidence
33
+
34
+ - Generated README surfaces stayed read-only.
35
+ - Source-affecting passes were validated with `npm run docs` and
36
+ `npx tsc --noEmit -p tsconfig.json`.
37
+
38
+ ## Reopen triggers
39
+
40
+ - Flappy Bird chapter openings drift below the current educational-docs bar.
41
+ - A changed or new boundary needs fresh intro-owner mapping.
42
+ - Generated chapter ownership regresses and needs new ordering controls.
@@ -2,116 +2,34 @@
2
2
 
3
3
  **Status:** [DONE]
4
4
 
5
- ## Purpose
5
+ ## Scope
6
6
 
7
- Run a folder-focused documentation pass across every README-owning folder under
8
- `test/examples/flappy_bird` so the generated documentation reads like a guided
9
- tour of the example architecture rather than a sparse export inventory.
7
+ - Educational-docs pass across the README-owning Flappy Bird example folders.
8
+ - Source-first only: generated surfaces stayed read-only and intro ownership
9
+ was corrected in source files or `docs.order.json` controls.
10
10
 
11
- ## Root
11
+ ## Final state
12
12
 
13
- - Split root: `test/examples/flappy_bird`
14
- - README inventory: 24 README-owning folders under the root
15
- - Nearest README reviewed: `test/examples/flappy_bird/README.md`
16
- - Parent README reviewed: `test/examples/README.md` if needed per step
17
- - Relevant plan: `plans/Interactive_Examples_and_Learning_Path.md`
13
+ - The tracked Flappy Bird example folders were reviewed and the weak chapter
14
+ openings were strengthened from their source owners.
15
+ - The documentation path from root example overview through trainer,
16
+ simulation, worker, and browser-entry chapters now reads coherently.
17
+ - No active backlog remains in this workstream; this file is now a reopen point
18
+ for future Flappy Bird documentation drift only.
18
19
 
19
- ## Durable Rules
20
+ ## Audit summary
20
21
 
21
- - Keep the README inventory explicit and visible in the todo list.
22
- - Keep exactly one active README or README-owning folder at a time.
23
- - Do not hand-edit generated subfolder README files; improve source JSDoc and
24
- regenerate docs.
25
- - Keep compatibility facades documented as facades, not as implementation sinks.
26
- - Prefer educational JSDoc that explains what, why, invariants, defaults, and
27
- performance tradeoffs when those details help a learner understand the example.
22
+ - Source-affecting passes regenerated docs with `npm run docs`.
23
+ - Source-affecting passes validated types with
24
+ `npx tsc --noEmit -p tsconfig.json`.
28
25
 
29
- ## Target Shape
26
+ ## Reopen conditions
30
27
 
31
- - Each README-owning folder has source JSDoc rich enough to generate a useful
32
- README without manual rescue edits.
33
- - Compatibility facades explain where deeper responsibilities live.
34
- - Browser, evaluation, simulation, worker, and trainer boundaries read like a
35
- coherent architecture map when browsed top-down.
28
+ - Flappy Bird README openings drift back below the current documentation bar.
29
+ - A new Flappy Bird example boundary needs chapter-level intro ownership work.
30
+ - Generated README ownership needs another `docs.order.json` correction.
36
31
 
37
- ## Steps
32
+ ## Audit log
38
33
 
39
- - [x] Step 1: Tidy the root `test/examples/flappy_bird` surface and verify the
40
- README inventory-driven workflow.
41
- - [x] Step 2: Tidy the worker and trainer-facing folders.
42
- - [x] Step 3: Tidy shared simulation, environment, constants, and evaluation
43
- folders.
44
- - [x] Step 4: Tidy browser-entry and its nested README-owning folders one by one.
45
- - [x] Step 5: Regenerate docs, run focused validation, and record any durable
46
- boundary notes that changed during the pass.
47
-
48
- ## Step 1 Inventory
49
-
50
- - [x] `test/examples/flappy_bird`
51
-
52
- ## Step 2 Inventory
53
-
54
- - [x] `test/examples/flappy_bird/trainer`
55
- - [x] `test/examples/flappy_bird/trainer/evaluation`
56
- - [x] `test/examples/flappy_bird/flappy-evolution-worker`
57
-
58
- ## Step 3 Inventory
59
-
60
- - [x] `test/examples/flappy_bird/constants`
61
- - [x] `test/examples/flappy_bird/environment`
62
- - [x] `test/examples/flappy_bird/evaluation`
63
- - [x] `test/examples/flappy_bird/evaluation/rollout`
64
- - [x] `test/examples/flappy_bird/simulation-shared`
65
- - [x] `test/examples/flappy_bird/simulation-shared/observation`
66
-
67
- ## Step 4 Inventory
68
-
69
- - [x] `test/examples/flappy_bird/browser-entry`
70
- - [x] `test/examples/flappy_bird/browser-entry/host`
71
- - [x] `test/examples/flappy_bird/browser-entry/host/resize`
72
- - [x] `test/examples/flappy_bird/browser-entry/network-view`
73
- - [x] `test/examples/flappy_bird/browser-entry/playback`
74
- - [x] `test/examples/flappy_bird/browser-entry/playback/background`
75
- - [x] `test/examples/flappy_bird/browser-entry/playback/background/ground-grid`
76
- - [x] `test/examples/flappy_bird/browser-entry/playback/frame-render`
77
- - [x] `test/examples/flappy_bird/browser-entry/playback/snapshot`
78
- - [x] `test/examples/flappy_bird/browser-entry/playback/trail`
79
- - [x] `test/examples/flappy_bird/browser-entry/playback/worker-channel`
80
- - [x] `test/examples/flappy_bird/browser-entry/runtime`
81
- - [x] `test/examples/flappy_bird/browser-entry/visualization`
82
- - [x] `test/examples/flappy_bird/browser-entry/worker-channel`
83
-
84
- ## Latest Pass
85
-
86
- ### Goals
87
-
88
- - Run a final pedagogical audit of the full Flappy Bird example.
89
- - Close the last remaining chapter-opening gap before finalizing the pass.
90
-
91
- ### Progress
92
-
93
- - Re-audited the root, trainer, browser-entry, and worker-facing generated
94
- READMEs against the guided-tour bar.
95
- - Found one remaining worker-boundary drift where the generated README opened on
96
- a constant shelf instead of the worker entrypoint.
97
- - Added a file-level worker chapter intro and `docs.order.json` source mapping
98
- so `flappy-evolution-worker/README.md` now opens on the worker boundary.
99
- - Ran `npx tsc --noEmit -p tsconfig.json` and `npm run docs` after the edits.
100
- - Re-read the regenerated worker README and confirmed the full 24-folder README
101
- inventory now reads coherently top-down.
102
- - No durable boundary notes changed during the pass; the work stayed within the
103
- existing module boundaries and documentation source map.
104
-
105
- ### Decision
106
-
107
- - The Flappy Bird folder documentation pass is complete and now meets the
108
- end-to-end pedagogical bar for the example.
109
-
110
- ## Done Criteria
111
-
112
- - Every README-owning folder in the inventory has been handled explicitly.
113
- - Generated README content is educational and boundary-aware.
114
- - The todo list reflects completion folder by folder.
115
- - Docs regeneration succeeds after documentation-affecting changes.
116
- - A later session can resume from this plan and the todo list without prior chat
117
- history.
34
+ - Durable completion notes now live in
35
+ [Flappy_Bird_Folder_Documentation_Pass.logs.md](Flappy_Bird_Folder_Documentation_Pass.logs.md).
package/plans/README.md CHANGED
@@ -13,6 +13,8 @@ Status convention:
13
13
  - Every roadmap-tracked plan file should expose a top-level status line immediately under the title.
14
14
  - Use the exact format `**Status:** [DONE]`, `**Status:** [WIP]`, or `**Status:** [PLANNED]`.
15
15
  - Keep that top-level status aligned with [plans/Roadmap.md](Roadmap.md), which is the authoritative source for cross-plan sequencing and active priority.
16
+ - Completed plans should prefer a short closed tracker plus a same-boundary
17
+ `.logs.md` companion file for audit history and durable milestone evidence.
16
18
  - Detailed phase-local status notes can still appear deeper in a plan when they add useful implementation detail.
17
19
 
18
20
  Recommended reading order:
@@ -26,7 +28,7 @@ Recommended reading order:
26
28
  Selection guide:
27
29
 
28
30
  - `plans/analyze-trace-solid-split.plans.md`: completed trace-analyzer tooling split and reopen point for future script-boundary work.
29
- - `plans/architecture-solid-split.plans.md`: active architecture folderization and boundary-ownership cleanup across `src/architecture`.
31
+ - `plans/architecture-solid-split.plans.md`: completed architecture folderization and docs follow-through baseline, kept as the reopen point for future facade-removal or ownership audits in `src/architecture`.
30
32
  - `plans/neat.plans.md`: core NEAT correctness, innovation tracking, crossover alignment, speciation invariants.
31
33
  - `plans/Roadmap.md`: dependency-aware execution order across all initiatives.
32
34
  - `plans/Architecture_Primitives_Node_Group_Layer.md`: first-class architecture-building primitives such as nodes, groups, and layers.
@@ -42,7 +44,8 @@ Selection guide:
42
44
  - `plans/Memory_Optimization.md`: scaling, memory layout, and strategies for very large networks.
43
45
  - `plans/methods-docs.plans.md`: completed educational-docs lane for `src/methods` and reopen point for methods documentation drift.
44
46
  - `plans/methods-solid-split.plans.md`: completed structural split lane for `src/methods` and reopen point for later refactors.
45
- - `plans/neat-docs.plans.md`: active educational-docs lane for NEAT surfaces and generated README quality.
47
+ - `plans/neat-docs.plans.md`: completed educational-docs baseline for root-facing NEAT surfaces, kept as the reopen point for future README-opening drift or generator-ordering regressions.
48
+ - `plans/readme-first-section-pass.plans.md`: completed repo-wide README-opening baseline across `src/` and `test/examples/`; use the matching `.logs.md` file for audit history and reopen the plan only if a changed boundary or new README surface reopens the lane.
46
49
  - `plans/neat-test-surface-repair.plans.md`: completed NEAT public test-surface repair baseline and reopen point for future compatibility regressions.
47
50
  - `plans/Network_Visualization_Export_Schema.md`: stable export schema for visualization and inspection tooling.
48
51
  - `plans/ONNX_EXPORT_PLAN.md`: ONNX export/import architecture and rollout phases.
@@ -73,6 +76,7 @@ Task-to-plan trigger phrases:
73
76
  - methods docs, methods README quality, educational-docs for methods: `plans/methods-docs.plans.md`
74
77
  - methods split, `src/methods` refactor, methods folderization: `plans/methods-solid-split.plans.md`
75
78
  - NEAT docs, generated README quality, NEAT documentation lane: `plans/neat-docs.plans.md`
79
+ - README opening, first section, chapter intro quality, repo-wide README openings, `src` plus `test/examples` docs pass: `plans/readme-first-section-pass.plans.md`
76
80
  - NEAT test surface, public type compatibility, root facade repair: `plans/neat-test-surface-repair.plans.md`
77
81
  - explicit any, no-explicit-any, strict typing, src lint cleanup follow-up, reopen completed cleanup lane: `plans/src-no-explicit-any-cleanup.plans.md`
78
82
  - HTML docs renderer, sidebar, Mermaid validation, docs site tooling split: `plans/render-docs-html-solid-split.plans.md`
package/plans/Roadmap.md CHANGED
@@ -19,15 +19,18 @@ Where it helps, this roadmap uses **lanes** (things that can proceed in parallel
19
19
  - `asciiMaze` SOLID split before ES2023 modernization [DONE]
20
20
  - `flappy_bird` reference demo split and documentation baseline [DONE]
21
21
  - Main app NEAT surface is already SOLID split [DONE]
22
- - Educational documentation and split follow-through lane [WIP]
22
+ - Educational documentation and split follow-through lane [DONE]
23
23
  - [Flappy_Bird_Folder_Documentation_Pass.md](Flappy_Bird_Folder_Documentation_Pass.md) [DONE]
24
- - [architecture-solid-split.plans.md](architecture-solid-split.plans.md) [WIP]
24
+ - [architecture-solid-split.plans.md](architecture-solid-split.plans.md) [DONE]
25
25
  - [methods-solid-split.plans.md](methods-solid-split.plans.md) [DONE]
26
26
  - [methods-docs.plans.md](methods-docs.plans.md) [DONE]
27
- - [neat-docs.plans.md](neat-docs.plans.md) [WIP]
27
+ - [neat-docs.plans.md](neat-docs.plans.md) [DONE]
28
+ - [readme-first-section-pass.plans.md](readme-first-section-pass.plans.md) [DONE]
28
29
  - [utils-docs.plans.md](utils-docs.plans.md) [DONE]
29
30
  - Both demos are now solid split and the Flappy Bird documentation pass is complete enough to stop being a documentation blocker.
30
- - The remaining structural polish in Phase 0 is the broader educational-docs lane outside methods, the architecture folderization pass, and the repository-wide modernization pass with their validation gate.
31
+ - The architecture split follow-through and the NEAT educational-docs lane are now also complete enough to stop being Phase 0 blockers.
32
+ - The repo-wide README first-section pass is now closed across the tracked README surfaces under `src/` and `test/examples/`.
33
+ - The remaining structural polish in Phase 0 is the repository-wide modernization pass plus its validation gate.
31
34
  - Supporting repair and docs-tooling stabilization lane [DONE]
32
35
  - [neat-test-surface-repair.plans.md](neat-test-surface-repair.plans.md) [DONE]
33
36
  - [asciiMaze-typescript-repair.plans.md](asciiMaze-typescript-repair.plans.md) [DONE]
@@ -162,7 +165,7 @@ This plan is large and can run as a **parallel lane** after Phase 1, but it shou
162
165
 
163
166
  ## Summary: Critical Path vs Parallel Lanes
164
167
 
165
- Current status: the project is still in **Phase 0**, with both demos solid split and documented, the example learnability pass now materially strengthened across `test/examples`, the Flappy Bird documentation pass now closed, the main app already solid split, the architecture split pass now active, the broader educational documentation lane still in progress outside Flappy Bird, the `src/` strict-typing cleanup now closed as a completed baseline, and repository-wide ES2023 modernization still remaining in the Phase 0 lane.
168
+ Current status: the project is still in **Phase 0**, with both demos solid split and documented, the example learnability pass materially strengthened across `test/examples`, the Flappy Bird documentation pass now closed, the main app already solid split, the architecture split follow-through now closed, the broader educational documentation lane now closed including the repo-wide README first-section pass, the `src/` strict-typing cleanup now closed as a completed baseline, and repository-wide ES2023 modernization still remaining in the Phase 0 lane.
166
169
 
167
170
  - **Critical path:** Phase 0 → Phase 1 → Phase 2 → Phase 3 → Phase 4
168
171
  - **Parallel lane A (performance):** [Memory_Optimization.md](Memory_Optimization.md) Track 1 after Phase 1 stabilizes
@@ -180,52 +183,53 @@ than a roadmap-tracked plan file.
180
183
  ### Phase 0 inventory
181
184
 
182
185
  1. [Flappy_Bird_Folder_Documentation_Pass.md](Flappy_Bird_Folder_Documentation_Pass.md) [DONE]
183
- 2. [architecture-solid-split.plans.md](architecture-solid-split.plans.md) [WIP]
186
+ 2. [architecture-solid-split.plans.md](architecture-solid-split.plans.md) [DONE]
184
187
  3. [methods-solid-split.plans.md](methods-solid-split.plans.md) [DONE]
185
188
  4. [methods-docs.plans.md](methods-docs.plans.md) [DONE]
186
- 5. [neat-docs.plans.md](neat-docs.plans.md) [WIP]
187
- 6. [utils-docs.plans.md](utils-docs.plans.md) [DONE]
188
- 7. [neat-test-surface-repair.plans.md](neat-test-surface-repair.plans.md) [DONE]
189
- 8. [asciiMaze-typescript-repair.plans.md](asciiMaze-typescript-repair.plans.md) [DONE]
190
- 9. [generate-docs-solid-split.plans.md](generate-docs-solid-split.plans.md) [DONE]
191
- 10. [render-docs-html-solid-split.plans.md](render-docs-html-solid-split.plans.md) [DONE]
192
- 11. [analyze-trace-solid-split.plans.md](analyze-trace-solid-split.plans.md) [DONE]
193
- 12. [src-no-explicit-any-cleanup.plans.md](src-no-explicit-any-cleanup.plans.md) [DONE]
194
- 13. [ES2023 migration](ES2023%20migration) [PLANNED]
189
+ 5. [neat-docs.plans.md](neat-docs.plans.md) [DONE]
190
+ 6. [readme-first-section-pass.plans.md](readme-first-section-pass.plans.md) [DONE]
191
+ 7. [utils-docs.plans.md](utils-docs.plans.md) [DONE]
192
+ 8. [neat-test-surface-repair.plans.md](neat-test-surface-repair.plans.md) [DONE]
193
+ 9. [asciiMaze-typescript-repair.plans.md](asciiMaze-typescript-repair.plans.md) [DONE]
194
+ 10. [generate-docs-solid-split.plans.md](generate-docs-solid-split.plans.md) [DONE]
195
+ 11. [render-docs-html-solid-split.plans.md](render-docs-html-solid-split.plans.md) [DONE]
196
+ 12. [analyze-trace-solid-split.plans.md](analyze-trace-solid-split.plans.md) [DONE]
197
+ 13. [src-no-explicit-any-cleanup.plans.md](src-no-explicit-any-cleanup.plans.md) [DONE]
198
+ 14. [ES2023 migration](ES2023%20migration) [PLANNED]
195
199
 
196
200
  ### Phase 1 inventory
197
201
 
198
- 14. [neat.plans.md](neat.plans.md) [PLANNED]
199
- 15. [Stable_Activation_Ordering_and_Explicit_IO_Roles.md](Stable_Activation_Ordering_and_Explicit_IO_Roles.md) [PLANNED]
202
+ 15. [neat.plans.md](neat.plans.md) [PLANNED]
203
+ 16. [Stable_Activation_Ordering_and_Explicit_IO_Roles.md](Stable_Activation_Ordering_and_Explicit_IO_Roles.md) [PLANNED]
200
204
 
201
205
  ### Phase 2 inventory
202
206
 
203
- 16. [Architecture_Primitives_Node_Group_Layer.md](Architecture_Primitives_Node_Group_Layer.md) [PLANNED]
204
- 17. [Construct_From_Parts_Graph_Assembly.md](Construct_From_Parts_Graph_Assembly.md) [PLANNED]
205
- 18. [Preconfigured_Architectures_MLP_LSTM_GRU_NARX.md](Preconfigured_Architectures_MLP_LSTM_GRU_NARX.md) [PLANNED]
207
+ 17. [Architecture_Primitives_Node_Group_Layer.md](Architecture_Primitives_Node_Group_Layer.md) [PLANNED]
208
+ 18. [Construct_From_Parts_Graph_Assembly.md](Construct_From_Parts_Graph_Assembly.md) [PLANNED]
209
+ 19. [Preconfigured_Architectures_MLP_LSTM_GRU_NARX.md](Preconfigured_Architectures_MLP_LSTM_GRU_NARX.md) [PLANNED]
206
210
 
207
211
  ### Phase 3 inventory
208
212
 
209
- 19. [Browser_Build_and_CDN_Distribution.md](Browser_Build_and_CDN_Distribution.md) [PLANNED]
210
- 20. [Interactive_Examples_and_Learning_Path.md](Interactive_Examples_and_Learning_Path.md) [PLANNED]
211
- 21. [Network_Visualization_Export_Schema.md](Network_Visualization_Export_Schema.md) [PLANNED]
213
+ 20. [Browser_Build_and_CDN_Distribution.md](Browser_Build_and_CDN_Distribution.md) [PLANNED]
214
+ 21. [Interactive_Examples_and_Learning_Path.md](Interactive_Examples_and_Learning_Path.md) [PLANNED]
215
+ 22. [Network_Visualization_Export_Schema.md](Network_Visualization_Export_Schema.md) [PLANNED]
212
216
 
213
217
  ### Phase 4 inventory
214
218
 
215
- 22. [Standalone_Inference_Export.md](Standalone_Inference_Export.md) [PLANNED]
216
- 23. [Worker_Friendly_Network_Serialization_Fastpath.md](Worker_Friendly_Network_Serialization_Fastpath.md) [PLANNED]
217
- 24. [Turnkey_Multithread_Evaluation_API.md](Turnkey_Multithread_Evaluation_API.md) [PLANNED]
218
- 25. [Population_Save_Resume_and_Checkpointing.md](Population_Save_Resume_and_Checkpointing.md) [PLANNED]
219
- 26. [Evolution_Training_Interoperability_Contracts.md](Evolution_Training_Interoperability_Contracts.md) [PLANNED]
219
+ 23. [Standalone_Inference_Export.md](Standalone_Inference_Export.md) [PLANNED]
220
+ 24. [Worker_Friendly_Network_Serialization_Fastpath.md](Worker_Friendly_Network_Serialization_Fastpath.md) [PLANNED]
221
+ 25. [Turnkey_Multithread_Evaluation_API.md](Turnkey_Multithread_Evaluation_API.md) [PLANNED]
222
+ 26. [Population_Save_Resume_and_Checkpointing.md](Population_Save_Resume_and_Checkpointing.md) [PLANNED]
223
+ 27. [Evolution_Training_Interoperability_Contracts.md](Evolution_Training_Interoperability_Contracts.md) [PLANNED]
220
224
 
221
225
  ### Phase 5 inventory
222
226
 
223
- 27. [Memory_Optimization.md](Memory_Optimization.md) [WIP]
227
+ 28. [Memory_Optimization.md](Memory_Optimization.md) [WIP]
224
228
 
225
229
  ### Phase 6 inventory
226
230
 
227
- 28. [ONNX_EXPORT_PLAN.md](ONNX_EXPORT_PLAN.md) [WIP]
231
+ 29. [ONNX_EXPORT_PLAN.md](ONNX_EXPORT_PLAN.md) [WIP]
228
232
 
229
233
  ### Phase 7 inventory
230
234
 
231
- 29. [HyperEvoDevoMorphoNEAT.md](HyperEvoDevoMorphoNEAT.md) [PLANNED]
235
+ 30. [HyperEvoDevoMorphoNEAT.md](HyperEvoDevoMorphoNEAT.md) [PLANNED]
@@ -0,0 +1,35 @@
1
+ # Analyze Trace SOLID Split Log
2
+
3
+ **Status:** [DONE]
4
+
5
+ ## Audit scope
6
+
7
+ - Objective: split the trace analyzer into a folder-owned subsystem while
8
+ preserving the trace-analysis command path and its reporting behavior.
9
+
10
+ ## Durable milestones
11
+
12
+ ### [DONE] Analyzer boundary split
13
+
14
+ - Established stable ownership for constants, types, shared helpers, I/O,
15
+ analysis, and reporting under the analyzer folder.
16
+
17
+ ### [DONE] Orchestration clarification
18
+
19
+ - Made the root flow clearer as resolve, load, analyze, and print so future
20
+ trace extensions land on a stable orchestration surface.
21
+
22
+ ### [DONE] Determinism follow-through
23
+
24
+ - Added deterministic sort-tie handling so equal-duration sections produce
25
+ stable ordering across runs.
26
+
27
+ ## Controls and evidence
28
+
29
+ - Validation used clean file diagnostics,
30
+ `npx tsc --noEmit -p tsconfig.docs.json`, and `npm run trace:analyze`.
31
+
32
+ ## Reopen triggers
33
+
34
+ - Future analyzer features require deeper subfolder work.
35
+ - Deterministic ordering or report output regresses.
@@ -4,63 +4,32 @@
4
4
 
5
5
  ## Scope
6
6
 
7
- - Folderize the trace analyzer into [scripts/analyze-trace](../scripts/analyze-trace) with a stable entrypoint at [scripts/analyze-trace/analyze-trace.ts](../scripts/analyze-trace/analyze-trace.ts).
8
- - Keep `npm run trace:analyze` stable by retargeting it to the folder-owned entrypoint instead of leaving a flat compatibility shim.
9
- - Improve JSDoc, naming clarity, and deterministic report assembly without changing the report's overall scope.
7
+ - Folderize the trace-analyzer script into a stable subsystem while keeping
8
+ `npm run trace:analyze` behavior intact.
9
+ - Leave the analyzer in a reopen-only state for future feature work.
10
10
 
11
- ## Current state
11
+ ## Final state
12
12
 
13
- - Split root: `scripts/analyze-trace/`
14
- - README inventory for `scripts/`: none under `scripts/**/README.md`
15
- - Relevant plan: `n/a` (tooling-only trace analyzer tidy; no direct roadmap lane)
16
- - Stable entrypoint: `scripts/analyze-trace/analyze-trace.ts`
17
- - Landed folder files:
18
- - `scripts/analyze-trace/analyze-trace.ts`
19
- - `scripts/analyze-trace/analyze-trace.constants.ts`
20
- - `scripts/analyze-trace/analyze-trace.types.ts`
21
- - `scripts/analyze-trace/analyze-trace.shared.ts`
22
- - `scripts/analyze-trace/analyze-trace.io.ts`
23
- - `scripts/analyze-trace/analyze-trace.analysis.ts`
24
- - `scripts/analyze-trace/analyze-trace.report.ts`
25
- - Closed issues in this step:
26
- - CLI parsing, trace loading, analysis, shared helpers, and report rendering no longer live in one file,
27
- - the split now uses a real folder boundary instead of scattering module files at the scripts root,
28
- - deterministic sort tie-breaks now make equal-duration sections more stable across runs,
29
- - the stable min/max timestamp scan remains single-pass for large traces.
13
+ - The trace analyzer now has stable folder-owned boundaries for constants,
14
+ types, shared helpers, I/O, analysis, and reporting.
15
+ - The orchestration flow is clearer and deterministic behavior was improved for
16
+ equal-duration sort ties.
17
+ - No active backlog remains; this file is now a reopen point for future
18
+ analyzer extensions.
30
19
 
31
- ## Coverage backlog
20
+ ## Audit summary
32
21
 
33
- ### [DONE] Folder-owned analyzer split
22
+ - Validation used `npx tsc --noEmit -p tsconfig.docs.json` and
23
+ `npm run trace:analyze`.
24
+ - File diagnostics were kept clean through the split.
34
25
 
35
- - Moved the analyzer into [scripts/analyze-trace](../scripts/analyze-trace) and retargeted `npm run trace:analyze` to [scripts/analyze-trace/analyze-trace.ts](../scripts/analyze-trace/analyze-trace.ts).
36
- - Separated constants, contracts, shared utility helpers, CLI/file I/O, analysis passes, and text-report rendering inside the folder boundary.
37
- - Preserved the existing report sections while making the orchestration flow read as resolve -> load -> analyze -> print.
26
+ ## Reopen conditions
38
27
 
39
- ### [DONE] Educational docs follow-up
28
+ - New trace-analysis features outgrow the current structure.
29
+ - Analyzer determinism or report ordering regresses.
30
+ - Script-boundary work reopens the trace analyzer subsystem.
40
31
 
41
- - Added educational JSDoc to the folder-owned constants, contracts, helpers, and report surface so future trace-tooling changes can start from an intentional boundary map instead of a single oversized file.
32
+ ## Audit log
42
33
 
43
- ## Validation
44
-
45
- - File diagnostics: clean for the touched `scripts/analyze-trace/*.ts` files.
46
- - `npx tsc --noEmit -p tsconfig.docs.json`
47
- - `npm run trace:analyze -- test/examples/flappy_bird/Trace-20260309T191949.json --top=5`
48
-
49
- ## Immediate next steps
50
-
51
- - No further split work is queued for this boundary right now.
52
- - Future analyzer changes should continue inside `scripts/analyze-trace/` instead of re-growing a flat scripts-root boundary.
53
-
54
- ## Handoff query
55
-
56
- ```text
57
- Continue from the current repo state only. Do not rely on prior chat history.
58
-
59
- Use solid-split for #file:analyze-trace.
60
- Plan: plans/analyze-trace-solid-split.plans.md.
61
- Current boundary: scripts/analyze-trace/.
62
- Completed context: scripts has no local README surface, scripts/analyze-trace/analyze-trace.ts is the stable CLI entrypoint, and the analyzer now splits responsibilities across constants, types, shared helpers, CLI/file I/O, analysis, and report rendering inside one owned folder.
63
- Repo standard: direct-path migration with no compatibility shims by default, and the small-chapter mindset applies to scripts/tooling boundaries.
64
- Required validations: file diagnostics for touched files, npx tsc --noEmit -p tsconfig.docs.json, then npm run trace:analyze -- test/examples/flappy_bird/Trace-20260309T191949.json --top=5.
65
- Worktree caution: there may already be unrelated generated README drift elsewhere in the repo.
66
- ```
34
+ - Durable completion notes now live in
35
+ [analyze-trace-solid-split.logs.md](analyze-trace-solid-split.logs.md).
@@ -0,0 +1,44 @@
1
+ # Architecture Solid Split Log
2
+
3
+ **Status:** [DONE]
4
+
5
+ ## Audit scope
6
+
7
+ - Objective: convert the flat `src/architecture/` area into stable folder-owned
8
+ module boundaries and repair the generated chapter structure that depended on
9
+ those boundaries.
10
+
11
+ ## Durable milestones
12
+
13
+ ### [DONE] Root and family split baseline
14
+
15
+ - Closed the split across the core architecture families, including the root
16
+ architecture surface plus the main node, connection, group, architect, and
17
+ network ownership boundaries.
18
+ - Eliminated the dependency on a facade-dominated root README opening.
19
+
20
+ ### [DONE] Network and ONNX subchapter structure
21
+
22
+ - Split deeper network and ONNX concerns into stable subchapters so future work
23
+ can extend them without returning to a flat-file architecture root.
24
+ - Preserved public behavior while moving implementation and doc ownership into
25
+ the intended folders.
26
+
27
+ ### [DONE] Documentation ownership follow-through
28
+
29
+ - Added and tuned `docs.order.json` controls so generated chapter openings come
30
+ from the right public owner files and chapter maps.
31
+ - Closed the README-opening follow-through that the split exposed.
32
+
33
+ ## Controls and evidence
34
+
35
+ - Validation after structural and doc-affecting edits used `npm run docs` and
36
+ `npx tsc --noEmit -p tsconfig.json`.
37
+ - The final architecture root is now a durable baseline rather than an active
38
+ split frontier.
39
+
40
+ ## Reopen triggers
41
+
42
+ - Future architecture changes reintroduce facade-heavy or oversized roots.
43
+ - Public-import cleanup is intentionally resumed.
44
+ - ONNX or network chapters need another structural split.