@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.
- package/.github/agents/boundary-mapper.agent.md +13 -8
- package/.github/agents/docs-scout.agent.md +14 -9
- package/.github/agents/plan-scout.agent.md +11 -6
- package/.github/agents/solid-split.agent.md +33 -17
- package/.github/copilot-instructions.md +100 -88
- package/.github/skills/educational-docs/SKILL.md +90 -40
- package/.github/skills/educational-docs/assets/mermaid-diagram-playbook.md +141 -141
- package/.github/skills/educational-docs/assets/visual-style-guide.md +1 -1
- package/.github/skills/plan-alignment/SKILL.md +1 -1
- package/.github/skills/solid-split/SKILL.md +54 -35
- package/.github/skills/solid-split/assets/docs-checklist.md +1 -1
- package/.github/skills/solid-split/assets/split-plan-template.md +41 -12
- package/.github/skills/solid-split/assets/split-workflow-checklist.md +4 -1
- package/.github/skills/test-fix-workflow/SKILL.md +12 -7
- package/.github/skills/trace-analyzer-extension/SKILL.md +1 -1
- 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 +1 -1
- package/.github/skills/trace-audit-reporting/assets/performance-report-template.md +1 -1
- package/.github/skills/trace-audit-reporting/references/trace-analysis-workflow.md +1 -1
- package/.github/skills/tracker-handoff/SKILL.md +53 -5
- package/package.json +1 -1
- package/plans/Flappy_Bird_Folder_Documentation_Pass.logs.md +42 -0
- package/plans/Flappy_Bird_Folder_Documentation_Pass.md +22 -104
- package/plans/README.md +6 -2
- package/plans/Roadmap.md +35 -31
- package/plans/analyze-trace-solid-split.logs.md +35 -0
- package/plans/analyze-trace-solid-split.plans.md +21 -52
- package/plans/architecture-solid-split.logs.md +44 -0
- package/plans/architecture-solid-split.plans.md +20 -653
- package/plans/asciiMaze-typescript-repair.logs.md +35 -0
- package/plans/asciiMaze-typescript-repair.plans.md +30 -36
- package/plans/generate-docs-solid-split.logs.md +36 -0
- package/plans/generate-docs-solid-split.plans.md +21 -73
- package/plans/methods-docs.logs.md +37 -0
- package/plans/methods-docs.plans.md +22 -183
- package/plans/methods-solid-split.logs.md +41 -0
- package/plans/methods-solid-split.plans.md +23 -65
- package/plans/neat-docs.logs.md +38 -0
- package/plans/neat-docs.plans.md +21 -63
- package/plans/neat-test-surface-repair.logs.md +38 -0
- package/plans/neat-test-surface-repair.plans.md +24 -24
- package/plans/readme-first-section-pass.logs.md +63 -0
- package/plans/readme-first-section-pass.plans.md +42 -0
- package/plans/render-docs-html-solid-split.logs.md +36 -0
- package/plans/render-docs-html-solid-split.plans.md +20 -54
- package/plans/src-no-explicit-any-cleanup.logs.md +39 -0
- package/plans/src-no-explicit-any-cleanup.plans.md +23 -161
- package/plans/utils-docs.logs.md +37 -0
- package/plans/utils-docs.plans.md +20 -35
- package/src/README.md +88 -22
- package/src/architecture/README.md +94 -17
- package/src/architecture/activationArrayPool/README.md +53 -0
- package/src/architecture/activationArrayPool/activationArrayPool.ts +53 -0
- package/src/architecture/layer/README.md +94 -5
- package/src/architecture/layer/layer.ts +94 -5
- package/src/architecture/network/README.md +85 -14
- package/src/architecture/network/activate/README.md +301 -213
- package/src/architecture/network/activate/docs.order.json +9 -0
- package/src/architecture/network/activate/network.activate.utils.ts +90 -0
- package/src/architecture/network/connect/README.md +80 -3
- package/src/architecture/network/connect/docs.order.json +9 -0
- package/src/architecture/network/connect/network.connect.utils.ts +79 -0
- package/src/architecture/network/deterministic/README.md +96 -12
- package/src/architecture/network/deterministic/docs.order.json +10 -0
- package/src/architecture/network/deterministic/network.deterministic.utils.ts +90 -0
- package/src/architecture/network/evolve/README.md +286 -228
- package/src/architecture/network/evolve/docs.order.json +11 -0
- package/src/architecture/network/evolve/network.evolve.utils.ts +59 -0
- package/src/architecture/network/gating/README.md +58 -16
- package/src/architecture/network/gating/docs.order.json +9 -0
- package/src/architecture/network/gating/network.gating.utils.ts +43 -0
- package/src/architecture/network/genetic/README.md +75 -36
- package/src/architecture/network/genetic/docs.order.json +10 -0
- package/src/architecture/network/genetic/network.genetic.utils.ts +53 -17
- package/src/architecture/network/network.ts +91 -46
- package/src/architecture/network/standalone/README.md +309 -285
- package/src/architecture/network/standalone/docs.order.json +13 -0
- package/src/architecture/network/standalone/network.standalone.utils.ts +51 -28
- package/src/architecture/network.ts +94 -17
- package/src/architecture/nodePool/README.md +53 -0
- package/src/architecture/nodePool/nodePool.ts +53 -0
- package/src/methods/README.md +80 -34
- package/src/methods/methods.ts +80 -34
- package/src/methods/mutation/README.md +39 -93
- package/src/methods/mutation/mutation.ts +58 -0
- package/src/multithreading/README.md +114 -14
- package/src/multithreading/docs.order.json +5 -0
- package/src/multithreading/multi.ts +103 -7
- package/src/multithreading/types.ts +6 -1
- package/src/multithreading/workers/README.md +72 -2
- package/src/multithreading/workers/browser/README.md +39 -0
- package/src/multithreading/workers/browser/testworker.ts +40 -0
- package/src/multithreading/workers/node/README.md +50 -11
- package/src/multithreading/workers/node/docs.order.json +4 -0
- package/src/multithreading/workers/node/testworker.ts +43 -3
- package/src/multithreading/workers/workers.ts +36 -1
- package/src/neat/README.md +230 -152
- package/src/neat/adaptive/core/README.md +99 -42
- package/src/neat/adaptive/core/adaptive.core.ts +71 -14
- package/src/neat/adaptive/core/docs.order.json +8 -0
- package/src/neat/docs.order.json +9 -0
- package/src/neat/lineage/README.md +118 -16
- package/src/neat/lineage/lineage.ts +115 -13
- package/src/neat/neat.defaults.constants.ts +91 -13
- package/src/neat.ts +86 -20
- package/src/utils/README.md +71 -21
- package/src/utils/memory.ts +69 -19
- package/test/examples/asciiMaze/browser-entry/README.md +81 -8
- package/test/examples/asciiMaze/browser-entry/browser-entry.ts +81 -8
- package/test/examples/asciiMaze/dashboardManager/README.md +68 -4
- package/test/examples/asciiMaze/dashboardManager/dashboardManager.ts +68 -4
- package/test/examples/asciiMaze/evolutionEngine/README.md +1259 -1174
- package/test/examples/asciiMaze/evolutionEngine/docs.order.json +10 -0
- package/test/examples/asciiMaze/evolutionEngine/evolutionEngine.types.ts +87 -0
- package/test/examples/asciiMaze/mazeMovement/README.md +81 -4
- package/test/examples/asciiMaze/mazeMovement/mazeMovement.ts +81 -4
- package/test/examples/flappy_bird/browser-entry/README.md +64 -21
- package/test/examples/flappy_bird/browser-entry/browser-entry.ts +64 -21
- package/test/examples/flappy_bird/flappy-evolution-worker/README.md +98 -10
- package/test/examples/flappy_bird/flappy-evolution-worker/flappy-evolution-worker.ts +98 -10
- package/test/examples/flappy_bird/simulation-shared/README.md +88 -4
- package/test/examples/flappy_bird/simulation-shared/simulation-shared.types.ts +88 -4
|
@@ -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
|
-
|
|
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
|
-
|
|
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
|
|
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
|
@@ -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
|
-
##
|
|
5
|
+
## Scope
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
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
|
-
##
|
|
11
|
+
## Final state
|
|
12
12
|
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
-
|
|
16
|
-
|
|
17
|
-
-
|
|
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
|
-
##
|
|
20
|
+
## Audit summary
|
|
20
21
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
|
|
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
|
-
##
|
|
26
|
+
## Reopen conditions
|
|
30
27
|
|
|
31
|
-
-
|
|
32
|
-
|
|
33
|
-
-
|
|
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
|
-
##
|
|
32
|
+
## Audit log
|
|
38
33
|
|
|
39
|
-
-
|
|
40
|
-
|
|
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`:
|
|
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`:
|
|
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 [
|
|
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) [
|
|
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) [
|
|
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
|
|
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
|
|
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) [
|
|
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) [
|
|
187
|
-
6. [
|
|
188
|
-
7. [
|
|
189
|
-
8. [
|
|
190
|
-
9. [
|
|
191
|
-
10. [
|
|
192
|
-
11. [
|
|
193
|
-
12. [
|
|
194
|
-
13. [
|
|
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
|
-
|
|
199
|
-
|
|
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
|
-
|
|
204
|
-
|
|
205
|
-
|
|
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
|
-
|
|
210
|
-
|
|
211
|
-
|
|
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
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
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
|
-
|
|
227
|
+
28. [Memory_Optimization.md](Memory_Optimization.md) [WIP]
|
|
224
228
|
|
|
225
229
|
### Phase 6 inventory
|
|
226
230
|
|
|
227
|
-
|
|
231
|
+
29. [ONNX_EXPORT_PLAN.md](ONNX_EXPORT_PLAN.md) [WIP]
|
|
228
232
|
|
|
229
233
|
### Phase 7 inventory
|
|
230
234
|
|
|
231
|
-
|
|
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
|
|
8
|
-
|
|
9
|
-
-
|
|
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
|
-
##
|
|
11
|
+
## Final state
|
|
12
12
|
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
|
|
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
|
-
##
|
|
20
|
+
## Audit summary
|
|
32
21
|
|
|
33
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
32
|
+
## Audit log
|
|
42
33
|
|
|
43
|
-
|
|
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.
|