@reicek/neataptic-ts 0.1.24 → 0.1.26
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.
- package/.github/copilot-instructions.md +11 -0
- package/.github/skills/trace-analyzer-extension/SKILL.md +3 -3
- package/.github/skills/trace-analyzer-extension/assets/extension-checklist.md +1 -1
- package/.github/skills/trace-analyzer-extension/references/analyzer-extension-workflow.md +1 -1
- package/.github/skills/trace-audit-reporting/SKILL.md +3 -3
- package/.github/skills/trace-audit-reporting/references/trace-analysis-workflow.md +1 -1
- package/.github/workflows/ci.yml +3 -3
- package/.github/workflows/deploy-pages.yml +6 -6
- package/.github/workflows/manual_release_pipeline.yml +3 -3
- package/.github/workflows/publish.yml +18 -19
- package/.github/workflows/release_dispatch.yml +3 -3
- package/package.json +26 -20
- package/plans/Flappy_Bird_Folder_Documentation_Pass.md +4 -4
- package/plans/README.md +24 -0
- package/plans/Roadmap.md +62 -40
- package/plans/analyze-trace-solid-split.plans.md +66 -0
- package/plans/architecture-solid-split.plans.md +9 -15
- package/plans/asciiMaze-typescript-repair.plans.md +1 -1
- package/plans/generate-docs-solid-split.plans.md +87 -0
- package/plans/methods-docs.plans.md +25 -1
- package/plans/methods-solid-split.plans.md +14 -14
- package/plans/neat-docs.plans.md +9 -1
- package/plans/neat-test-surface-repair.plans.md +1 -1
- package/plans/render-docs-html-solid-split.plans.md +68 -0
- package/plans/src-no-explicit-any-cleanup.plans.md +1 -1
- package/plans/utils-docs.plans.md +6 -1
- package/scripts/analyze-trace/analyze-trace.analysis.ts +479 -0
- package/scripts/analyze-trace/analyze-trace.constants.ts +35 -0
- package/scripts/analyze-trace/analyze-trace.io.ts +69 -0
- package/scripts/analyze-trace/analyze-trace.report.ts +100 -0
- package/scripts/analyze-trace/analyze-trace.shared.ts +116 -0
- package/scripts/analyze-trace/analyze-trace.ts +45 -0
- package/scripts/analyze-trace/analyze-trace.types.ts +72 -0
- package/scripts/assets/theme.css +80 -23
- package/scripts/copy-examples.ts +239 -0
- package/scripts/export-onnx.ts +223 -0
- package/scripts/generate-bench-tables.ts +378 -37
- package/scripts/generate-docs/generate-docs.constants.ts +107 -0
- package/scripts/generate-docs/generate-docs.order.ts +355 -0
- package/scripts/generate-docs/generate-docs.state.ts +31 -0
- package/scripts/generate-docs/generate-docs.targets.ts +165 -0
- package/scripts/generate-docs/generate-docs.ts +63 -0
- package/scripts/generate-docs/generate-docs.types.ts +112 -0
- package/scripts/generate-docs/output/generate-docs.output.folder-index.utils.ts +167 -0
- package/scripts/generate-docs/output/generate-docs.output.ordering.utils.ts +353 -0
- package/scripts/generate-docs/output/generate-docs.output.readme.utils.ts +420 -0
- package/scripts/generate-docs/output/generate-docs.output.ts +123 -0
- package/scripts/generate-docs/output/generate-docs.output.warnings.utils.ts +219 -0
- package/scripts/generate-docs/symbols/generate-docs.symbols.collection.utils.ts +365 -0
- package/scripts/generate-docs/symbols/generate-docs.symbols.jsdoc.utils.ts +373 -0
- package/scripts/generate-docs/symbols/generate-docs.symbols.normalize.utils.ts +155 -0
- package/scripts/generate-docs/symbols/generate-docs.symbols.render.utils.ts +149 -0
- package/scripts/generate-docs/symbols/generate-docs.symbols.signature.utils.ts +289 -0
- package/scripts/generate-docs/symbols/generate-docs.symbols.ts +11 -0
- package/scripts/mermaid-cli.mjs +102 -22
- package/scripts/mermaid-cli.ts +736 -0
- package/scripts/render-docs-html/render-docs-html.assets.ts +54 -0
- package/scripts/render-docs-html/render-docs-html.mermaid.ts +245 -0
- package/scripts/{render-docs-html.sidebar.ts → render-docs-html/render-docs-html.navigation.ts} +141 -144
- package/scripts/render-docs-html/render-docs-html.pages.ts +333 -0
- package/scripts/render-docs-html/render-docs-html.shared.ts +333 -0
- package/scripts/render-docs-html/render-docs-html.types.ts +42 -0
- package/scripts/render-docs-html.ts +23 -587
- package/scripts/run-docs.ts +238 -0
- package/scripts/write-dist-docs-pkg.ts +40 -0
- package/src/README.md +75 -75
- package/src/architecture/connection/README.md +5 -5
- package/src/architecture/layer/README.md +508 -508
- package/src/architecture/network/README.md +1458 -1458
- package/src/architecture/network/activate/README.md +694 -694
- package/src/architecture/network/bootstrap/README.md +77 -77
- package/src/architecture/network/connect/README.md +74 -74
- package/src/architecture/network/deterministic/README.md +135 -135
- package/src/architecture/network/evolve/README.md +364 -364
- package/src/architecture/network/gating/README.md +130 -130
- package/src/architecture/network/genetic/README.md +399 -399
- package/src/architecture/network/mutate/README.md +897 -897
- package/src/architecture/network/onnx/README.md +720 -720
- package/src/architecture/network/onnx/export/README.md +728 -728
- package/src/architecture/network/onnx/export/layers/README.md +450 -450
- package/src/architecture/network/onnx/import/README.md +618 -618
- package/src/architecture/network/onnx/schema/README.md +32 -32
- package/src/architecture/network/prune/README.md +245 -245
- package/src/architecture/network/remove/README.md +135 -135
- package/src/architecture/network/runtime/README.md +106 -106
- package/src/architecture/network/serialize/README.md +542 -542
- package/src/architecture/network/slab/README.md +608 -608
- package/src/architecture/network/standalone/README.md +212 -212
- package/src/architecture/network/stats/README.md +84 -84
- package/src/architecture/network/topology/README.md +465 -465
- package/src/architecture/network/training/README.md +200 -200
- package/src/architecture/node/README.md +5 -5
- package/src/architecture/nodePool/README.md +14 -14
- package/src/methods/README.md +99 -99
- package/src/methods/activation/README.md +189 -189
- package/src/methods/cost/README.md +131 -131
- package/src/methods/rate/README.md +86 -86
- package/src/multithreading/README.md +77 -77
- package/src/multithreading/workers/browser/README.md +8 -8
- package/src/multithreading/workers/node/README.md +8 -8
- package/src/neat/README.md +148 -148
- package/src/neat/adaptive/README.md +120 -120
- package/src/neat/adaptive/acceptance/README.md +40 -40
- package/src/neat/adaptive/complexity/README.md +137 -137
- package/src/neat/adaptive/core/README.md +197 -197
- package/src/neat/adaptive/lineage/README.md +90 -90
- package/src/neat/adaptive/mutation/README.md +284 -284
- package/src/neat/compat/README.md +43 -43
- package/src/neat/compat/core/README.md +90 -90
- package/src/neat/diversity/README.md +35 -35
- package/src/neat/diversity/core/README.md +88 -88
- package/src/neat/evaluate/README.md +85 -85
- package/src/neat/evaluate/auto-distance/README.md +75 -75
- package/src/neat/evaluate/entropy-compat/README.md +37 -37
- package/src/neat/evaluate/entropy-sharing/README.md +43 -43
- package/src/neat/evaluate/fitness/README.md +23 -23
- package/src/neat/evaluate/novelty/README.md +120 -120
- package/src/neat/evaluate/objectives/README.md +17 -17
- package/src/neat/evaluate/shared/README.md +94 -94
- package/src/neat/evolve/README.md +96 -96
- package/src/neat/evolve/adaptive/README.md +60 -60
- package/src/neat/evolve/objectives/README.md +63 -63
- package/src/neat/evolve/offspring/README.md +56 -56
- package/src/neat/evolve/population/README.md +171 -171
- package/src/neat/evolve/runtime/README.md +79 -79
- package/src/neat/evolve/speciation/README.md +74 -74
- package/src/neat/evolve/warnings/README.md +10 -10
- package/src/neat/export/README.md +114 -114
- package/src/neat/helpers/README.md +50 -50
- package/src/neat/init/README.md +9 -9
- package/src/neat/lineage/core/README.md +101 -101
- package/src/neat/multiobjective/category/README.md +74 -74
- package/src/neat/multiobjective/crowding/README.md +272 -272
- package/src/neat/multiobjective/dominance/README.md +171 -171
- package/src/neat/multiobjective/fronts/README.md +68 -68
- package/src/neat/multiobjective/metrics/README.md +43 -43
- package/src/neat/multiobjective/objectives/README.md +31 -31
- package/src/neat/multiobjective/shared/README.md +27 -27
- package/src/neat/mutation/README.md +97 -97
- package/src/neat/mutation/add-conn/README.md +115 -115
- package/src/neat/mutation/add-node/README.md +126 -126
- package/src/neat/mutation/flow/README.md +149 -149
- package/src/neat/mutation/repair/README.md +185 -185
- package/src/neat/mutation/select/README.md +117 -117
- package/src/neat/mutation/shared/README.md +32 -32
- package/src/neat/objectives/README.md +25 -25
- package/src/neat/objectives/core/README.md +67 -67
- package/src/neat/pruning/README.md +40 -40
- package/src/neat/pruning/core/README.md +171 -171
- package/src/neat/pruning/facade/README.md +32 -32
- package/src/neat/rng/README.md +104 -104
- package/src/neat/rng/core/README.md +137 -137
- package/src/neat/rng/facade/README.md +50 -50
- package/src/neat/selection/README.md +111 -111
- package/src/neat/selection/core/README.md +227 -227
- package/src/neat/selection/facade/README.md +61 -61
- package/src/neat/shared/README.md +163 -163
- package/src/neat/speciation/README.md +31 -31
- package/src/neat/speciation/threshold/README.md +35 -35
- package/src/neat/species/README.md +25 -25
- package/src/neat/species/core/README.md +20 -20
- package/src/neat/species/core/shared/README.md +18 -18
- package/src/neat/species/history/context/README.md +22 -22
- package/src/neat/telemetry/accessors/README.md +58 -58
- package/src/neat/telemetry/exports/README.md +233 -233
- package/src/neat/telemetry/facade/README.md +252 -252
- package/src/neat/telemetry/facade/archive/README.md +57 -57
- package/src/neat/telemetry/facade/buffer/README.md +43 -43
- package/src/neat/telemetry/facade/lineage/README.md +12 -12
- package/src/neat/telemetry/facade/objectives/README.md +44 -44
- package/src/neat/telemetry/facade/runtime/README.md +26 -26
- package/src/neat/telemetry/facade/species/README.md +27 -27
- package/src/neat/telemetry/metrics/README.md +696 -696
- package/src/neat/telemetry/recorder/README.md +57 -57
- package/src/neat/telemetry/types/README.md +32 -32
- package/src/neat/topology-intent/README.md +75 -75
- package/src/utils/README.md +193 -193
- package/test/examples/asciiMaze/browser-entry/README.md +92 -92
- package/test/examples/asciiMaze/dashboardManager/README.md +109 -109
- package/test/examples/asciiMaze/dashboardManager/telemetry/README.md +28 -28
- package/test/examples/asciiMaze/evolutionEngine/README.md +1527 -1527
- package/test/examples/asciiMaze/mazeMovement/README.md +105 -105
- package/test/examples/asciiMaze/mazeMovement/finalization/README.md +16 -16
- package/test/examples/asciiMaze/mazeMovement/policy/README.md +57 -57
- package/test/examples/asciiMaze/mazeMovement/runtime/README.md +52 -52
- package/test/examples/asciiMaze/mazeMovement/shaping/README.md +46 -46
- package/test/examples/flappy_bird/browser-entry/README.md +508 -508
- package/test/examples/flappy_bird/browser-entry/host/README.md +101 -101
- package/test/examples/flappy_bird/browser-entry/host/resize/README.md +144 -144
- package/test/examples/flappy_bird/browser-entry/network-view/README.md +194 -194
- package/test/examples/flappy_bird/browser-entry/playback/README.md +278 -278
- package/test/examples/flappy_bird/browser-entry/playback/background/README.md +129 -129
- package/test/examples/flappy_bird/browser-entry/playback/background/ground-grid/README.md +502 -502
- package/test/examples/flappy_bird/browser-entry/playback/frame-render/README.md +139 -139
- package/test/examples/flappy_bird/browser-entry/playback/snapshot/README.md +10 -10
- package/test/examples/flappy_bird/browser-entry/playback/trail/README.md +43 -43
- package/test/examples/flappy_bird/browser-entry/playback/worker-channel/README.md +30 -30
- package/test/examples/flappy_bird/browser-entry/runtime/README.md +59 -59
- package/test/examples/flappy_bird/browser-entry/visualization/README.md +276 -276
- package/test/examples/flappy_bird/browser-entry/worker-channel/README.md +16 -16
- package/test/examples/flappy_bird/constants/README.md +1070 -1070
- package/test/examples/flappy_bird/environment/README.md +22 -22
- package/test/examples/flappy_bird/evaluation/README.md +32 -32
- package/test/examples/flappy_bird/evaluation/rollout/README.md +141 -141
- package/test/examples/flappy_bird/flappy-evolution-worker/README.md +425 -425
- package/test/examples/flappy_bird/simulation-shared/README.md +170 -170
- package/test/examples/flappy_bird/simulation-shared/observation/README.md +109 -109
- package/test/examples/flappy_bird/trainer/README.md +325 -325
- package/test/examples/flappy_bird/trainer/evaluation/README.md +74 -74
- package/scripts/analyze-trace.ts +0 -590
- package/scripts/copy-examples.mjs +0 -114
- package/scripts/export-onnx.mjs +0 -86
- package/scripts/generate-bench-tables.mjs +0 -182
- package/scripts/generate-docs.ts +0 -2900
- package/scripts/write-dist-docs-pkg.mjs +0 -16
package/plans/Roadmap.md
CHANGED
|
@@ -20,20 +20,27 @@ Where it helps, this roadmap uses **lanes** (things that can proceed in parallel
|
|
|
20
20
|
- `flappy_bird` reference demo split and documentation baseline [DONE]
|
|
21
21
|
- Main app NEAT surface is already SOLID split [DONE]
|
|
22
22
|
- Educational documentation and split follow-through lane [WIP]
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
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]
|
|
25
|
+
- [methods-solid-split.plans.md](methods-solid-split.plans.md) [DONE]
|
|
26
|
+
- [methods-docs.plans.md](methods-docs.plans.md) [DONE]
|
|
27
|
+
- [neat-docs.plans.md](neat-docs.plans.md) [WIP]
|
|
28
|
+
- [utils-docs.plans.md](utils-docs.plans.md) [DONE]
|
|
29
|
+
- 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
|
+
- Supporting repair and docs-tooling stabilization lane [DONE]
|
|
32
|
+
- [neat-test-surface-repair.plans.md](neat-test-surface-repair.plans.md) [DONE]
|
|
33
|
+
- [asciiMaze-typescript-repair.plans.md](asciiMaze-typescript-repair.plans.md) [DONE]
|
|
34
|
+
- [generate-docs-solid-split.plans.md](generate-docs-solid-split.plans.md) [DONE]
|
|
35
|
+
- [render-docs-html-solid-split.plans.md](render-docs-html-solid-split.plans.md) [DONE]
|
|
36
|
+
- [analyze-trace-solid-split.plans.md](analyze-trace-solid-split.plans.md) [DONE]
|
|
37
|
+
- These remain roadmap-visible as reopen points and tooling baselines even though they do not change the forward critical path out of Phase 0.
|
|
31
38
|
- Source strict-typing cleanup for `src/` explicit-`any` debt [DONE]
|
|
32
|
-
|
|
33
|
-
|
|
39
|
+
- Plan: [src-no-explicit-any-cleanup.plans.md](src-no-explicit-any-cleanup.plans.md)
|
|
40
|
+
- Scope note: this lane replaced the stale root checklist with a roadmap-tracked plan aligned to the current folderized tree and is now the closed baseline for future reopen-only follow-up.
|
|
34
41
|
- ES2023 modernization (after the demo-structure pass; mechanical refactors + CI enforcement) [PLANNED]
|
|
35
|
-
|
|
36
|
-
|
|
42
|
+
- Plan: [ES2023 migration](ES2023%20migration)
|
|
43
|
+
- Scope note: this phase is syntax/module modernization plus CI enforcement. Memory-management or performance-feature work remains owned by [Memory_Optimization.md](Memory_Optimization.md).
|
|
37
44
|
|
|
38
45
|
**Gate to Phase 1:** both demos are solid split and documented, the main app split is stable, the remaining documentation work is no longer obscuring ownership boundaries, and `npx tsc --noEmit -p tsconfig.json` plus `npm test` are green after the modernization pass.
|
|
39
46
|
|
|
@@ -91,13 +98,20 @@ Where it helps, this roadmap uses **lanes** (things that can proceed in parallel
|
|
|
91
98
|
9. Standalone inference export (dependency-free runtime output)
|
|
92
99
|
- Plan: [Standalone_Inference_Export.md](Standalone_Inference_Export.md) [PLANNED]
|
|
93
100
|
10. Worker-friendly serialization fastpath (clone/transfer payloads; predictor creation)
|
|
94
|
-
|
|
101
|
+
|
|
102
|
+
- Plan: [Worker_Friendly_Network_Serialization_Fastpath.md](Worker_Friendly_Network_Serialization_Fastpath.md) [PLANNED]
|
|
103
|
+
|
|
95
104
|
11. Turnkey multithread evaluation API (Node + browser workers)
|
|
96
|
-
|
|
105
|
+
|
|
106
|
+
- Plan: [Turnkey_Multithread_Evaluation_API.md](Turnkey_Multithread_Evaluation_API.md) [PLANNED]
|
|
107
|
+
|
|
97
108
|
12. Population save/resume + checkpointing (full vs light checkpoints, determinism contracts)
|
|
98
|
-
|
|
109
|
+
|
|
110
|
+
- Plan: [Population_Save_Resume_and_Checkpointing.md](Population_Save_Resume_and_Checkpointing.md) [PLANNED]
|
|
111
|
+
|
|
99
112
|
13. Evolution–training interoperability contracts (parameter vectors, isolation, hybrid policies)
|
|
100
|
-
|
|
113
|
+
|
|
114
|
+
- Plan: [Evolution_Training_Interoperability_Contracts.md](Evolution_Training_Interoperability_Contracts.md) [PLANNED]
|
|
101
115
|
|
|
102
116
|
**Why this ordering:**
|
|
103
117
|
|
|
@@ -113,8 +127,8 @@ Where it helps, this roadmap uses **lanes** (things that can proceed in parallel
|
|
|
113
127
|
This plan is large and can run as a **parallel lane** after Phase 1, but it should not destabilize correctness work.
|
|
114
128
|
|
|
115
129
|
- Memory & performance multi-layer strategy (Track 1: Phases 0–10; Track 2 gates Hyper work)
|
|
116
|
-
|
|
117
|
-
|
|
130
|
+
- Plan: [Memory_Optimization.md](Memory_Optimization.md) [WIP]
|
|
131
|
+
- Current internal state: Phases 0-3 are done, Phase 4 is next, and Track 2 Hyper work remains gated behind Track 1 stability.
|
|
118
132
|
|
|
119
133
|
**Recommended sequencing guidance:**
|
|
120
134
|
|
|
@@ -129,8 +143,8 @@ This plan is large and can run as a **parallel lane** after Phase 1, but it shou
|
|
|
129
143
|
**Outcome:** broader ecosystem compatibility and model portability.
|
|
130
144
|
|
|
131
145
|
- ONNX export/import breadth and hardening
|
|
132
|
-
|
|
133
|
-
|
|
146
|
+
- Plan: [ONNX_EXPORT_PLAN.md](ONNX_EXPORT_PLAN.md) [WIP]
|
|
147
|
+
- Current internal state: Phase 0-2 are complete, recurrent groundwork is implemented and still being hardened, and convolutional/spatial groundwork is in progress.
|
|
134
148
|
|
|
135
149
|
**Recommended timing:**
|
|
136
150
|
|
|
@@ -142,7 +156,7 @@ This plan is large and can run as a **parallel lane** after Phase 1, but it shou
|
|
|
142
156
|
**Outcome:** evo-devo / hyper-scale capabilities that build on top of all prior infrastructure.
|
|
143
157
|
|
|
144
158
|
- HyperEvoDevo MorphoNEAT
|
|
145
|
-
|
|
159
|
+
- Plan: [HyperEvoDevoMorphoNEAT.md](HyperEvoDevoMorphoNEAT.md) [PLANNED]
|
|
146
160
|
|
|
147
161
|
**Why last:** this work depends heavily on the Memory Optimization track (Track 2 in that plan) and benefits from stable NEAT correctness, deterministic activation semantics, and robust serialization/checkpointing.
|
|
148
162
|
|
|
@@ -160,50 +174,58 @@ Current status: the project is still in **Phase 0**, with both demos solid split
|
|
|
160
174
|
This is the full `plans/` inventory flattened into execution order so every plan
|
|
161
175
|
file has a visible place in the roadmap.
|
|
162
176
|
|
|
177
|
+
This inventory excludes [README.md](README.md), which is the plans index rather
|
|
178
|
+
than a roadmap-tracked plan file.
|
|
179
|
+
|
|
163
180
|
### Phase 0 inventory
|
|
164
181
|
|
|
165
182
|
1. [Flappy_Bird_Folder_Documentation_Pass.md](Flappy_Bird_Folder_Documentation_Pass.md) [DONE]
|
|
166
183
|
2. [architecture-solid-split.plans.md](architecture-solid-split.plans.md) [WIP]
|
|
167
184
|
3. [methods-solid-split.plans.md](methods-solid-split.plans.md) [DONE]
|
|
168
185
|
4. [methods-docs.plans.md](methods-docs.plans.md) [DONE]
|
|
169
|
-
5. [docs.plans.md](docs.plans.md) [WIP]
|
|
186
|
+
5. [neat-docs.plans.md](neat-docs.plans.md) [WIP]
|
|
170
187
|
6. [utils-docs.plans.md](utils-docs.plans.md) [DONE]
|
|
171
|
-
7. [
|
|
172
|
-
8. [
|
|
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]
|
|
173
195
|
|
|
174
196
|
### Phase 1 inventory
|
|
175
197
|
|
|
176
|
-
|
|
177
|
-
|
|
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]
|
|
178
200
|
|
|
179
201
|
### Phase 2 inventory
|
|
180
202
|
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
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]
|
|
184
206
|
|
|
185
207
|
### Phase 3 inventory
|
|
186
208
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
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]
|
|
190
212
|
|
|
191
213
|
### Phase 4 inventory
|
|
192
214
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
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]
|
|
198
220
|
|
|
199
221
|
### Phase 5 inventory
|
|
200
222
|
|
|
201
|
-
|
|
223
|
+
27. [Memory_Optimization.md](Memory_Optimization.md) [WIP]
|
|
202
224
|
|
|
203
225
|
### Phase 6 inventory
|
|
204
226
|
|
|
205
|
-
|
|
227
|
+
28. [ONNX_EXPORT_PLAN.md](ONNX_EXPORT_PLAN.md) [WIP]
|
|
206
228
|
|
|
207
229
|
### Phase 7 inventory
|
|
208
230
|
|
|
209
|
-
|
|
231
|
+
29. [HyperEvoDevoMorphoNEAT.md](HyperEvoDevoMorphoNEAT.md) [PLANNED]
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Analyze Trace SOLID Split
|
|
2
|
+
|
|
3
|
+
**Status:** [DONE]
|
|
4
|
+
|
|
5
|
+
## Scope
|
|
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.
|
|
10
|
+
|
|
11
|
+
## Current state
|
|
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.
|
|
30
|
+
|
|
31
|
+
## Coverage backlog
|
|
32
|
+
|
|
33
|
+
### [DONE] Folder-owned analyzer split
|
|
34
|
+
|
|
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.
|
|
38
|
+
|
|
39
|
+
### [DONE] Educational docs follow-up
|
|
40
|
+
|
|
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.
|
|
42
|
+
|
|
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
|
+
```
|
|
@@ -166,7 +166,7 @@ root. Keep exactly one boundary pass active at a time.
|
|
|
166
166
|
hides the flat root compatibility files from the generated architecture root
|
|
167
167
|
README while still using the configured intro summary as the directory-level
|
|
168
168
|
opening.
|
|
169
|
-
- [scripts/generate-docs.ts](../scripts/generate-docs.ts) now resolves a
|
|
169
|
+
- [scripts/generate-docs/generate-docs.ts](../scripts/generate-docs/generate-docs.ts) now resolves a
|
|
170
170
|
configured intro file from the full sorted file list rather than only the
|
|
171
171
|
visible file list, which allows hidden compatibility facades to remain the
|
|
172
172
|
source of the root chapter introduction.
|
|
@@ -180,7 +180,7 @@ root. Keep exactly one boundary pass active at a time.
|
|
|
180
180
|
|
|
181
181
|
1. Network class seam work is complete enough for audit mode.
|
|
182
182
|
2. The public-surface docs cleanup is complete; only reopen class-owned split
|
|
183
|
-
|
|
183
|
+
work if the refreshed README still exposes a concrete overloaded seam.
|
|
184
184
|
|
|
185
185
|
### [PLANNED] Deferred Questions
|
|
186
186
|
|
|
@@ -195,7 +195,7 @@ root. Keep exactly one boundary pass active at a time.
|
|
|
195
195
|
> Proceed
|
|
196
196
|
- Decide at the end of the active network workstream whether a separate
|
|
197
197
|
architecture-wide README size and thin-doc audit should become its own plan.
|
|
198
|
-
> Elaborate? We want full documentation
|
|
198
|
+
> Elaborate? We want full documentation
|
|
199
199
|
|
|
200
200
|
## Coverage Backlog
|
|
201
201
|
|
|
@@ -295,8 +295,7 @@ entry records the minimal extent of completed work and the current stop point.
|
|
|
295
295
|
[src/architecture/network/onnx/import/network.onnx.import-fused-recurrent.types.ts](../src/architecture/network/onnx/import/network.onnx.import-fused-recurrent.types.ts)
|
|
296
296
|
so the root compatibility barrel no longer owns the emitted LSTM/GRU replay
|
|
297
297
|
context family.
|
|
298
|
-
-
|
|
299
|
-
[src/architecture/network/onnx/import/network.onnx.import-fused-recurrent.utils.ts](../src/architecture/network/onnx/import/network.onnx.import-fused-recurrent.utils.ts)
|
|
298
|
+
- [src/architecture/network/onnx/import/network.onnx.import-fused-recurrent.utils.ts](../src/architecture/network/onnx/import/network.onnx.import-fused-recurrent.utils.ts)
|
|
300
299
|
now reads those importer-only contracts from the local import chapter while
|
|
301
300
|
the root file keeps only the shared `NodeInternals` and `OnnxLayerFactory`
|
|
302
301
|
bridge types.
|
|
@@ -310,12 +309,10 @@ entry records the minimal extent of completed work and the current stop point.
|
|
|
310
309
|
[src/architecture/network/onnx/import/README.md](../src/architecture/network/onnx/import/README.md)
|
|
311
310
|
now opens with the import pipeline story instead of inheriting its chapter
|
|
312
311
|
introduction from the runtime-factory leaf types file.
|
|
313
|
-
-
|
|
314
|
-
[src/architecture/network/onnx/import/docs.order.json](../src/architecture/network/onnx/import/docs.order.json)
|
|
312
|
+
- [src/architecture/network/onnx/import/docs.order.json](../src/architecture/network/onnx/import/docs.order.json)
|
|
315
313
|
now pins the import flow file as the intro source and keeps the generated
|
|
316
314
|
reading order aligned to the actual reconstruction pipeline.
|
|
317
|
-
-
|
|
318
|
-
[src/architecture/network/onnx/import/network.onnx.import-flow.utils.ts](../src/architecture/network/onnx/import/network.onnx.import-flow.utils.ts)
|
|
315
|
+
- [src/architecture/network/onnx/import/network.onnx.import-flow.utils.ts](../src/architecture/network/onnx/import/network.onnx.import-flow.utils.ts)
|
|
319
316
|
now explains the staged restore questions that link the neighboring runtime,
|
|
320
317
|
weight, activation, orchestration, and fused-recurrent chapters together.
|
|
321
318
|
- Validation completed with `npx tsc --noEmit -p tsconfig.json` and
|
|
@@ -328,12 +325,10 @@ entry records the minimal extent of completed work and the current stop point.
|
|
|
328
325
|
now opens with an explicit chapter map that tells readers when to continue
|
|
329
326
|
into the `export/`, `import/`, and `schema/` subchapters versus when to use
|
|
330
327
|
the root compatibility barrels.
|
|
331
|
-
-
|
|
332
|
-
[src/architecture/network/onnx/docs.order.json](../src/architecture/network/onnx/docs.order.json)
|
|
328
|
+
- [src/architecture/network/onnx/docs.order.json](../src/architecture/network/onnx/docs.order.json)
|
|
333
329
|
now pins the root ONNX reading order so the public entrypoint stays first and
|
|
334
330
|
the thinner root utility barrel appears before the larger root types barrel.
|
|
335
|
-
-
|
|
336
|
-
[src/architecture/network/onnx/network.onnx.ts](../src/architecture/network/onnx/network.onnx.ts)
|
|
331
|
+
- [src/architecture/network/onnx/network.onnx.ts](../src/architecture/network/onnx/network.onnx.ts)
|
|
337
332
|
now explains why the root chapter exists, how the folder is split, and how a
|
|
338
333
|
contributor should navigate the remaining compatibility surfaces.
|
|
339
334
|
- Validation completed with `npx tsc --noEmit -p tsconfig.json` and
|
|
@@ -384,8 +379,7 @@ entry records the minimal extent of completed work and the current stop point.
|
|
|
384
379
|
instead of dropping directly into the much larger
|
|
385
380
|
[src/architecture/network/network.types.ts](../src/architecture/network/network.types.ts)
|
|
386
381
|
shelf.
|
|
387
|
-
-
|
|
388
|
-
[src/architecture/network/docs.order.json](../src/architecture/network/docs.order.json)
|
|
382
|
+
- [src/architecture/network/docs.order.json](../src/architecture/network/docs.order.json)
|
|
389
383
|
now pins the chapter intro to the public `Network` class and keeps the
|
|
390
384
|
reading order aligned to public orchestration first, compatibility utilities
|
|
391
385
|
second, and the large root types shelf last.
|
|
@@ -39,4 +39,4 @@ Repair the remaining `test/examples/asciiMaze/**` TypeScript diagnostics in
|
|
|
39
39
|
```text
|
|
40
40
|
Continue from the current repo state only. Do not rely on prior chat history.
|
|
41
41
|
Work from plans/asciiMaze-typescript-repair.plans.md. The ASCII Maze TypeScript repair pass is complete: browser-entry, evolution-engine, setup/pruning, and telemetry compatibility seams were aligned, `npx tsc --noEmit -p tsconfig.test.json` is green, and `npm test` passes. Preserve unrelated user changes and only reopen this area if new diagnostics appear.
|
|
42
|
-
```
|
|
42
|
+
```
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Generate Docs SOLID Split
|
|
2
|
+
|
|
3
|
+
**Status:** [DONE]
|
|
4
|
+
|
|
5
|
+
## Scope
|
|
6
|
+
|
|
7
|
+
- Split the docs generator from the old flat [scripts/generate-docs.ts](../scripts/generate-docs/generate-docs.ts) boundary into a folder-owned module under `scripts/`.
|
|
8
|
+
- Keep the `docs:folders:*` CLI behavior stable by updating repo-local callers to the new built entrypoint instead of leaving a flat compatibility shim.
|
|
9
|
+
- Improve source readability with orchestration-first flow, focused helper ownership, and comprehensive JSDoc on the new exported surfaces.
|
|
10
|
+
|
|
11
|
+
## Current state
|
|
12
|
+
|
|
13
|
+
- Split root: `scripts/generate-docs/`
|
|
14
|
+
- Nearest README reviewed: `n/a` (no `scripts/**/README.md` files currently exist)
|
|
15
|
+
- Parent README reviewed: `n/a`
|
|
16
|
+
- Relevant plan: [plans/neat-docs.plans.md](../plans/neat-docs.plans.md)
|
|
17
|
+
- Adjacent reference checked: [plans/architecture-solid-split.plans.md](../plans/architecture-solid-split.plans.md)
|
|
18
|
+
- Current boundary: the root entrypoint now delegates to focused chapter files for targets, symbols, ordering, output, constants, state, and shared contracts.
|
|
19
|
+
- Active split frontier: `generate-docs.symbols.ts` and `generate-docs.output.ts` have each grown into their own responsibility clusters and now need direct-path subfolderization.
|
|
20
|
+
|
|
21
|
+
## Durable rules
|
|
22
|
+
|
|
23
|
+
- Keep exactly one active workstream section.
|
|
24
|
+
- Prefer direct-path migration to `scripts/generate-docs/generate-docs.ts`; do not leave a flat shim unless a real compatibility need appears.
|
|
25
|
+
- Do not hand-edit generated README files as part of this split.
|
|
26
|
+
- Run docs-tooling validation after the split because this boundary feeds `npm run docs`.
|
|
27
|
+
|
|
28
|
+
## Target shape
|
|
29
|
+
|
|
30
|
+
- `scripts/generate-docs/generate-docs.ts` owns CLI orchestration.
|
|
31
|
+
- `scripts/generate-docs/generate-docs.types.ts` owns shared docs-generator contracts.
|
|
32
|
+
- `scripts/generate-docs/generate-docs.constants.ts` owns stable constants and target definitions.
|
|
33
|
+
- `scripts/generate-docs/generate-docs.state.ts` owns shared ts-morph and docs-order cache state.
|
|
34
|
+
- `scripts/generate-docs/generate-docs.targets.ts` owns target resolution and source-tree preparation.
|
|
35
|
+
- `scripts/generate-docs/generate-docs.symbols.ts` owns symbol collection, JSDoc extraction, and dedupe rules.
|
|
36
|
+
- `scripts/generate-docs/generate-docs.order.ts` owns `docs.order.json` loading, validation, caching, and warnings.
|
|
37
|
+
- `scripts/generate-docs/generate-docs.output.ts` owns README rendering, folder-index rendering, and file emission.
|
|
38
|
+
|
|
39
|
+
## Coverage backlog
|
|
40
|
+
|
|
41
|
+
### [DONE] Generator root split
|
|
42
|
+
|
|
43
|
+
- Landed the folder-owned module at [scripts/generate-docs/generate-docs.ts](../scripts/generate-docs/generate-docs.ts) with dedicated chapter files for constants, types, state, targets, symbols, ordering, and output.
|
|
44
|
+
- Retargeted the repo-local docs scripts to `dist-docs/scripts/generate-docs/generate-docs.js` so the split uses direct-path migration with no flat compatibility shim.
|
|
45
|
+
- Updated the existing plan references that pointed at the deleted flat script path.
|
|
46
|
+
- Completed the required educational-docs follow-up by adding chapter-level source introductions to the new files so maintainers can read the split as a guided boundary map instead of a raw helper shelf.
|
|
47
|
+
|
|
48
|
+
### [DONE] Symbols and output chapter split
|
|
49
|
+
|
|
50
|
+
- Reopen the generator boundary to move `generate-docs.symbols.ts` into `scripts/generate-docs/symbols/` and `generate-docs.output.ts` into `scripts/generate-docs/output/`.
|
|
51
|
+
- Keep direct-path migration: update repo-local imports to the new subfolder entrypoints and delete the flat files after validations pass.
|
|
52
|
+
- Keep the new chapter roots orchestration-first, with narrower helper files for collection/rendering/signature work in the symbols boundary and README/index ordering work in the output boundary.
|
|
53
|
+
- Completed the direct-path move into `scripts/generate-docs/symbols/` and `scripts/generate-docs/output/`, removed the flat chapter files, and retargeted the root generator imports to the new nested entrypoints.
|
|
54
|
+
- Fixed the post-split behavioral regressions in the output boundary so `introFile` once again controls directory intro promotion and folder-index nodes keep correct source and link paths.
|
|
55
|
+
- Completed the mandatory educational-docs follow-up with contract-level JSDoc covering signature storage, file-summary precedence, intro promotion, and fallback ordering.
|
|
56
|
+
|
|
57
|
+
## Validation
|
|
58
|
+
|
|
59
|
+
- Completed in prior step:
|
|
60
|
+
- `npm run docs:build-scripts`
|
|
61
|
+
- `npm run docs`
|
|
62
|
+
- `npm run docs:build-scripts` after the educational-docs follow-up
|
|
63
|
+
- Completed for this step:
|
|
64
|
+
- `npm run docs:build-scripts`
|
|
65
|
+
- `npm run docs`
|
|
66
|
+
- `npm run docs:build-scripts` after the post-validation educational-docs follow-up
|
|
67
|
+
|
|
68
|
+
## Immediate next steps
|
|
69
|
+
|
|
70
|
+
- No further split work is queued in this boundary right now.
|
|
71
|
+
- Future work, if needed, should start from the nested `symbols/` and `output/` folders rather than recreating flat chapter files.
|
|
72
|
+
|
|
73
|
+
## Handoff query
|
|
74
|
+
|
|
75
|
+
```text
|
|
76
|
+
Continue docs-tooling work from the current repo state only. Do not rely on prior chat history.
|
|
77
|
+
|
|
78
|
+
Plan: plans/generate-docs-solid-split.plans.md
|
|
79
|
+
Current boundary: scripts/generate-docs/
|
|
80
|
+
Repo standard: migrate directly to scripts/generate-docs/generate-docs.ts with no compatibility shim by default, and keep the split in small responsibility chapters.
|
|
81
|
+
Small-chapter standard: this applies to scripts and tooling boundaries too, not only library code.
|
|
82
|
+
Already covered: the old flat generator script was removed, package.json now points at dist-docs/scripts/generate-docs/generate-docs.js, and the current root chapter files own targets, symbols, ordering, output, state, constants, and types.
|
|
83
|
+
Next task if this boundary reopens: continue from the nested scripts/generate-docs/symbols/ and scripts/generate-docs/output/ folders, preserving direct-path imports and the current docs-order behavior.
|
|
84
|
+
Required validations: npm run docs:build-scripts, npm run docs.
|
|
85
|
+
Worktree caution: .github/copilot-instructions.md may already have unrelated local edits.
|
|
86
|
+
Continue from the current repo state only. Do not rely on prior chat history.
|
|
87
|
+
```
|
|
@@ -8,10 +8,12 @@ This plan tracks educational-docs passes for the shared method vocabulary under
|
|
|
8
8
|
[src/methods/README.md](../src/methods/README.md).
|
|
9
9
|
|
|
10
10
|
Primary reader:
|
|
11
|
+
|
|
11
12
|
- readers who want the reusable training and evolutionary method families to
|
|
12
13
|
read like a guided policy shelf rather than a raw export list.
|
|
13
14
|
|
|
14
15
|
Primary surfaces:
|
|
16
|
+
|
|
15
17
|
- [src/methods/methods.ts](../src/methods/methods.ts)
|
|
16
18
|
- [src/methods/cost/cost.ts](../src/methods/cost/cost.ts)
|
|
17
19
|
- [src/methods/rate/rate.ts](../src/methods/rate/rate.ts)
|
|
@@ -25,10 +27,12 @@ Primary surfaces:
|
|
|
25
27
|
### Methods root chapter pass
|
|
26
28
|
|
|
27
29
|
Goals:
|
|
30
|
+
|
|
28
31
|
- Make the generated [src/methods/README.md](../src/methods/README.md) open as
|
|
29
32
|
a guided chapter instead of a raw export list.
|
|
30
33
|
|
|
31
34
|
Progress:
|
|
35
|
+
|
|
32
36
|
- Added a barrel-led introduction in
|
|
33
37
|
[src/methods/methods.ts](../src/methods/methods.ts) so the chapter now opens
|
|
34
38
|
with the shared method-family map.
|
|
@@ -38,18 +42,21 @@ Progress:
|
|
|
38
42
|
framing and diagram-justified guidance.
|
|
39
43
|
|
|
40
44
|
Decision:
|
|
45
|
+
|
|
41
46
|
- Keep future methods work proportional and continue one family chapter at a
|
|
42
47
|
time rather than reopening the entire folder.
|
|
43
48
|
|
|
44
49
|
### Activation chapter pass
|
|
45
50
|
|
|
46
51
|
Goals:
|
|
52
|
+
|
|
47
53
|
- Make the activation family read more like a chooser and less like a flat
|
|
48
54
|
list of transfer-curve helpers.
|
|
49
55
|
- Tighten the older symbol-level prose in the utility shelf without changing
|
|
50
56
|
runtime behavior.
|
|
51
57
|
|
|
52
58
|
Progress:
|
|
59
|
+
|
|
53
60
|
- Added a compact family map in
|
|
54
61
|
[src/methods/activation/activation.ts](../src/methods/activation/activation.ts)
|
|
55
62
|
so the generated activation chapter shows the main activation clusters before
|
|
@@ -61,18 +68,21 @@ Progress:
|
|
|
61
68
|
transforms.
|
|
62
69
|
|
|
63
70
|
Decision:
|
|
71
|
+
|
|
64
72
|
- Leave the deeper per-symbol registry cleanup for a later polish pass and keep
|
|
65
73
|
moving through the thin structural chapters one family at a time.
|
|
66
74
|
|
|
67
75
|
### Gating chapter pass
|
|
68
76
|
|
|
69
77
|
Goals:
|
|
78
|
+
|
|
70
79
|
- Make the gating family read like a structural chooser instead of a short
|
|
71
80
|
constant shelf.
|
|
72
81
|
- Clarify how `INPUT`, `OUTPUT`, and `SELF` differ so readers can pick a gate
|
|
73
82
|
position by intent instead of memorizing names.
|
|
74
83
|
|
|
75
84
|
Progress:
|
|
85
|
+
|
|
76
86
|
- Reframed [src/methods/gating/gating.ts](../src/methods/gating/gating.ts)
|
|
77
87
|
around the placement question the family answers, with stronger source-first
|
|
78
88
|
chooser guidance for the three gate positions.
|
|
@@ -80,6 +90,7 @@ Progress:
|
|
|
80
90
|
surface each option creates and includes a minimal example for quick recall.
|
|
81
91
|
|
|
82
92
|
Remaining gaps:
|
|
93
|
+
|
|
83
94
|
- The sibling structural family for connection policies is still thinner than
|
|
84
95
|
the rest of the methods shelf and likely needs the same chapter-first framing.
|
|
85
96
|
- If the methods root chapter gets another pass later, its short gating summary
|
|
@@ -87,18 +98,21 @@ Remaining gaps:
|
|
|
87
98
|
connection pass.
|
|
88
99
|
|
|
89
100
|
Next step:
|
|
101
|
+
|
|
90
102
|
- Move to the connection family next and give its structural wiring vocabulary
|
|
91
103
|
the same chooser-first treatment used for gating.
|
|
92
104
|
|
|
93
105
|
### Connection chapter pass
|
|
94
106
|
|
|
95
107
|
Goals:
|
|
108
|
+
|
|
96
109
|
- Make the connection family read like a wiring-policy chooser instead of a
|
|
97
110
|
terse list of topology names.
|
|
98
111
|
- Clarify when dense connectivity, dense-without-self-links, and one-to-one
|
|
99
112
|
alignment are the right structural defaults.
|
|
100
113
|
|
|
101
114
|
Progress:
|
|
115
|
+
|
|
102
116
|
- Reframed [src/methods/connection/connection.ts](../src/methods/connection/connection.ts)
|
|
103
117
|
around the structural question the family answers, with stronger source-first
|
|
104
118
|
guidance for the three built-in wiring patterns.
|
|
@@ -107,12 +121,14 @@ Progress:
|
|
|
107
121
|
recall.
|
|
108
122
|
|
|
109
123
|
Remaining gaps:
|
|
124
|
+
|
|
110
125
|
- The thin structural families are now better aligned, so future work here is
|
|
111
126
|
more likely to be polish than rescue.
|
|
112
127
|
- If the methods root chapter gets another pass later, its short structural
|
|
113
128
|
summaries for both gating and connection can be harmonized again for tone.
|
|
114
129
|
|
|
115
130
|
Next step:
|
|
131
|
+
|
|
116
132
|
- Re-read the methods root chapter and decide whether the next highest-value
|
|
117
133
|
pass is a small root-summary alignment pass or a deeper polish pass on one of
|
|
118
134
|
the larger method families.
|
|
@@ -120,12 +136,14 @@ Next step:
|
|
|
120
136
|
### Methods root alignment pass
|
|
121
137
|
|
|
122
138
|
Goals:
|
|
139
|
+
|
|
123
140
|
- Re-align the root methods introduction so its structural summary matches the
|
|
124
141
|
stronger gating and connection chapters.
|
|
125
142
|
- Keep the top-level chapter compact while making the difference between
|
|
126
143
|
routing control and wiring layout explicit.
|
|
127
144
|
|
|
128
145
|
Progress:
|
|
146
|
+
|
|
129
147
|
- Tightened [src/methods/methods.ts](../src/methods/methods.ts) so the root
|
|
130
148
|
chapter now describes `gating` and `groupConnection` as different parts of
|
|
131
149
|
the structural vocabulary instead of bundling them together too loosely.
|
|
@@ -134,24 +152,28 @@ Progress:
|
|
|
134
152
|
opening stays compact and source-first.
|
|
135
153
|
|
|
136
154
|
Remaining gaps:
|
|
155
|
+
|
|
137
156
|
- The methods root is now aligned with the thin structural chapters, so the
|
|
138
157
|
next useful pass is more likely to be selective polish than root framing.
|
|
139
158
|
- Larger families such as mutation or rate may still benefit from later
|
|
140
159
|
refinement, but they no longer block the root chapter from reading clearly.
|
|
141
160
|
|
|
142
161
|
Next step:
|
|
162
|
+
|
|
143
163
|
- Choose the next highest-value polish pass among the larger method families,
|
|
144
164
|
or stop here if the methods shelf is sufficiently aligned for now.
|
|
145
165
|
|
|
146
166
|
### Rate and mutation polish pass
|
|
147
167
|
|
|
148
168
|
Goals:
|
|
169
|
+
|
|
149
170
|
- Smooth the generated docs for two larger method-adjacent chapters without
|
|
150
171
|
reopening their runtime behavior.
|
|
151
172
|
- Remove remaining generated-doc rough edges such as duplicated framing and
|
|
152
173
|
awkward parameter prose.
|
|
153
174
|
|
|
154
175
|
Progress:
|
|
176
|
+
|
|
155
177
|
- Tightened [src/methods/rate/rate.ts](../src/methods/rate/rate.ts) so the
|
|
156
178
|
class-level chapter no longer repeats the full module opening and instead
|
|
157
179
|
acts like a practical chooser for schedule builders.
|
|
@@ -164,10 +186,12 @@ Progress:
|
|
|
164
186
|
generated mutation chapter reads less like raw annotation output.
|
|
165
187
|
|
|
166
188
|
Decision:
|
|
189
|
+
|
|
167
190
|
- Stop the methods documentation lane here for now; the root and the highest-
|
|
168
191
|
leverage family chapters now read coherently enough that further work is
|
|
169
192
|
polish, not structural rescue.
|
|
170
193
|
|
|
171
194
|
Next step:
|
|
195
|
+
|
|
172
196
|
- Pause this plan and revisit only if a later docs pass exposes a specific
|
|
173
|
-
regression, stale generated wording, or a newly expanded method family.
|
|
197
|
+
regression, stale generated wording, or a newly expanded method family.
|
|
@@ -43,31 +43,31 @@ each concept into its own folder-based boundary.
|
|
|
43
43
|
## Latest Pass
|
|
44
44
|
|
|
45
45
|
- Folderized the methods surface into chapter folders for `activation`, `cost`,
|
|
46
|
-
|
|
46
|
+
`rate`, `selection`, `mutation`, `crossover`, `gating`, and `connection`.
|
|
47
47
|
- Migrated repo-local imports to direct folder paths and removed the stale flat
|
|
48
|
-
|
|
48
|
+
`src/methods/mutation.ts` file that was still being compiled after the move.
|
|
49
49
|
- Updated `src/methods/methods.ts` to remain the root public facade and updated
|
|
50
|
-
|
|
50
|
+
root ordering via `src/methods/docs.order.json`.
|
|
51
51
|
- Added chapter-level ordering configs for `activation`, `cost`, and `rate` so
|
|
52
|
-
|
|
53
|
-
|
|
52
|
+
their nested READMEs open from the public facade files rather than utility
|
|
53
|
+
helpers.
|
|
54
54
|
- Updated `.github/skills/educational-docs/SKILL.md` so oversized generated
|
|
55
|
-
|
|
56
|
-
|
|
55
|
+
folder READMEs now point toward `solid-split` instead of continuing to grow
|
|
56
|
+
monolithically.
|
|
57
57
|
- Regenerated docs and verified the generated openings for
|
|
58
|
-
|
|
59
|
-
|
|
58
|
+
`src/methods/README.md`, `src/methods/activation/README.md`,
|
|
59
|
+
`src/methods/cost/README.md`, and `src/methods/rate/README.md`.
|
|
60
60
|
- Final validation completed with `npm run docs` and
|
|
61
|
-
|
|
61
|
+
`npx tsc --noEmit -p tsconfig.json`.
|
|
62
62
|
|
|
63
63
|
## Handoff State
|
|
64
64
|
|
|
65
65
|
- The split is complete and the root methods README now reads as a chapter map
|
|
66
|
-
|
|
66
|
+
rather than a monolithic flat file dump.
|
|
67
67
|
- Nested method READMEs are generated from source-first JSDoc and should be
|
|
68
|
-
|
|
68
|
+
maintained by editing the owning source files, not the generated READMEs.
|
|
69
69
|
- If a future methods family starts to feel oversized again, prefer another
|
|
70
|
-
|
|
70
|
+
bounded folder split over expanding the root README.
|
|
71
71
|
|
|
72
72
|
## Done Criteria
|
|
73
73
|
|
|
@@ -75,4 +75,4 @@ each concept into its own folder-based boundary.
|
|
|
75
75
|
- Repo-local imports point at the new direct folder paths.
|
|
76
76
|
- `src/methods/README.md` becomes smaller because chapter content moves into nested folder READMEs.
|
|
77
77
|
- The educational-docs skill explicitly points large monolithic README surfaces toward `solid-split`.
|
|
78
|
-
- The boundary can be resumed safely from this plan alone.
|
|
78
|
+
- The boundary can be resumed safely from this plan alone.
|