agents-inc 0.162.0 → 0.164.0
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/CHANGELOG.md +28 -0
- package/dist/{chunk-HRVPZMKK.js → chunk-2CQNPLVF.js} +35 -14
- package/dist/chunk-2CQNPLVF.js.map +1 -0
- package/dist/{chunk-VFZF7LVY.js → chunk-3WVH2CTK.js} +3 -3
- package/dist/{chunk-5J6DO4VW.js → chunk-4VL3CEOS.js} +3 -3
- package/dist/{chunk-QM3ZNOWJ.js → chunk-6MV4JOCL.js} +2 -2
- package/dist/{chunk-WIJM6BX6.js → chunk-7ANJQLPJ.js} +2 -2
- package/dist/{chunk-3JDVBHWO.js → chunk-7REKOTKG.js} +2 -2
- package/dist/{chunk-MI7LKLD7.js → chunk-ABAZMMG4.js} +2 -2
- package/dist/{chunk-XSM3IBMG.js → chunk-AOTCIUGX.js} +2 -2
- package/dist/{chunk-L65XGQKR.js → chunk-ARYNOWKF.js} +8 -8
- package/dist/{chunk-3QBOVV6A.js → chunk-AVK2HEKB.js} +5 -5
- package/dist/{chunk-3QBOVV6A.js.map → chunk-AVK2HEKB.js.map} +1 -1
- package/dist/{chunk-AQSMNUKJ.js → chunk-B3Y3QMWI.js} +4 -4
- package/dist/{chunk-ES7WGE32.js → chunk-B6FSLXYN.js} +3 -3
- package/dist/{chunk-S6GX7IJ2.js → chunk-DSL66I4N.js} +6 -6
- package/dist/{chunk-IMTWWA3N.js → chunk-ECURHW3T.js} +12 -12
- package/dist/{chunk-VEONZFTL.js → chunk-FLW25ORT.js} +3 -3
- package/dist/{chunk-53XPSAJ4.js → chunk-G2JJ5BO5.js} +17 -16
- package/dist/chunk-G2JJ5BO5.js.map +1 -0
- package/dist/{chunk-H2MDPOLG.js → chunk-JIERYE6B.js} +5 -5
- package/dist/{chunk-GFO55TMY.js → chunk-JU4ZGJ7A.js} +100 -24
- package/dist/chunk-JU4ZGJ7A.js.map +1 -0
- package/dist/{chunk-K26SBQLO.js → chunk-K5ITEA3I.js} +4 -4
- package/dist/{chunk-4KVJJJG2.js → chunk-LT5GXEB2.js} +6 -6
- package/dist/{chunk-2IMHZEIK.js → chunk-NKGYKOB7.js} +3 -3
- package/dist/{chunk-X6KXPRKI.js → chunk-NQXO4LR3.js} +4 -4
- package/dist/{chunk-ZFPQM63K.js → chunk-NTF4UXGK.js} +5 -5
- package/dist/{chunk-77YZFVQD.js → chunk-PHCPUQVR.js} +2 -2
- package/dist/{chunk-T2RPUNYP.js → chunk-Q4IRRVXK.js} +3 -3
- package/dist/{chunk-EN5MEPAS.js → chunk-QGUP3QJF.js} +5 -5
- package/dist/{chunk-MSUTHS2V.js → chunk-QZX7SYKU.js} +2 -2
- package/dist/{chunk-BR3TNSO3.js → chunk-RGYDFBCT.js} +4 -4
- package/dist/{chunk-4NAWM4OQ.js → chunk-S63LXWMC.js} +2 -2
- package/dist/{chunk-IV42Z63R.js → chunk-UITEKY2R.js} +19 -9
- package/dist/chunk-UITEKY2R.js.map +1 -0
- package/dist/{chunk-RMMEYCEA.js → chunk-URXIQE7I.js} +2 -2
- package/dist/{chunk-57YWAMNT.js → chunk-V5GLL2JB.js} +7 -7
- package/dist/{chunk-C53RJ7AA.js → chunk-X37UYIE3.js} +43 -41
- package/dist/chunk-X37UYIE3.js.map +1 -0
- package/dist/{chunk-J2YG7P7L.js → chunk-X4SSJZLY.js} +49 -6
- package/dist/chunk-X4SSJZLY.js.map +1 -0
- package/dist/{chunk-VEBEGZUV.js → chunk-XATLUKXK.js} +5 -5
- package/dist/{chunk-33ZKIYJM.js → chunk-XHPWTL4I.js} +3 -3
- package/dist/{chunk-UNASGGW2.js → chunk-XPDVAJDH.js} +69 -8
- package/dist/chunk-XPDVAJDH.js.map +1 -0
- package/dist/{chunk-FL2CJ5T5.js → chunk-YRS3QZP2.js} +3 -3
- package/dist/{chunk-FXL63LDL.js → chunk-ZVXGW2IC.js} +2 -2
- package/dist/commands/build/marketplace.js +7 -7
- package/dist/commands/build/plugins.js +7 -7
- package/dist/commands/compile.js +82 -30
- package/dist/commands/compile.js.map +1 -1
- package/dist/commands/doctor.js +10 -10
- package/dist/commands/doctor.js.map +1 -1
- package/dist/commands/edit.js +40 -38
- package/dist/commands/edit.js.map +1 -1
- package/dist/commands/eject.js +10 -10
- package/dist/commands/init.js +36 -36
- package/dist/commands/list.js +8 -8
- package/dist/commands/new/marketplace.js +7 -7
- package/dist/commands/search.js +10 -10
- package/dist/commands/share.js +8 -8
- package/dist/commands/uninstall.js +11 -11
- package/dist/commands/update.js +6 -6
- package/dist/components/common/removal-plan-confirm.js +2 -2
- package/dist/components/common/select-list.js +2 -2
- package/dist/components/wizard/category-grid.js +4 -4
- package/dist/components/wizard/checkbox-grid.js +4 -4
- package/dist/components/wizard/domain-selection.js +9 -9
- package/dist/components/wizard/run-wizard-session.js +26 -26
- package/dist/components/wizard/scroll-affordance.js +2 -2
- package/dist/components/wizard/skill-agent-summary.js +5 -5
- package/dist/components/wizard/source-grid.js +5 -5
- package/dist/components/wizard/stack-selection.js +7 -7
- package/dist/components/wizard/step-agents.js +8 -8
- package/dist/components/wizard/step-build.js +7 -7
- package/dist/components/wizard/step-confirm.js +9 -9
- package/dist/components/wizard/step-sources.js +8 -8
- package/dist/components/wizard/step-stack.js +8 -8
- package/dist/components/wizard/summary-panel.js +8 -8
- package/dist/components/wizard/toast.js +2 -2
- package/dist/components/wizard/wizard-layout.js +12 -12
- package/dist/components/wizard/wizard-tabs.js +2 -2
- package/dist/components/wizard/wizard.js +25 -25
- package/dist/hooks/init.js +36 -36
- package/dist/load-agent-defs-7IM3GBEQ.js +13 -0
- package/dist/recompile-project-agents-VR4NLGOU.js +17 -0
- package/dist/{source-loader-KAWB76OH.js → source-loader-GRBVNRAW.js} +4 -4
- package/dist/src/agents/_templates/agent.liquid +30 -122
- package/dist/src/agents/_templates/methodologies/operating-principles.liquid +27 -0
- package/dist/src/agents/developer/ai-developer/critical-reminders.md +9 -48
- package/dist/src/agents/developer/ai-developer/critical-requirements.md +29 -47
- package/dist/src/agents/developer/ai-developer/identity.md +31 -40
- package/dist/src/agents/developer/ai-developer/output.md +92 -245
- package/dist/src/agents/developer/ai-developer/playbook.md +116 -270
- package/dist/src/agents/developer/api-developer/critical-reminders.md +9 -40
- package/dist/src/agents/developer/api-developer/critical-requirements.md +19 -34
- package/dist/src/agents/developer/api-developer/identity.md +18 -33
- package/dist/src/agents/developer/api-developer/output.md +118 -255
- package/dist/src/agents/developer/api-developer/playbook.md +103 -284
- package/dist/src/agents/developer/cli-developer/critical-reminders.md +9 -45
- package/dist/src/agents/developer/cli-developer/critical-requirements.md +21 -39
- package/dist/src/agents/developer/cli-developer/identity.md +22 -36
- package/dist/src/agents/developer/cli-developer/output.md +72 -185
- package/dist/src/agents/developer/cli-developer/playbook.md +107 -307
- package/dist/src/agents/developer/web-developer/critical-reminders.md +9 -34
- package/dist/src/agents/developer/web-developer/critical-requirements.md +11 -30
- package/dist/src/agents/developer/web-developer/identity.md +15 -15
- package/dist/src/agents/developer/web-developer/output.md +67 -220
- package/dist/src/agents/developer/web-developer/playbook.md +93 -283
- package/dist/src/agents/meta/agent-summoner/critical-reminders.md +6 -39
- package/dist/src/agents/meta/agent-summoner/critical-requirements.md +6 -44
- package/dist/src/agents/meta/agent-summoner/identity.md +20 -23
- package/dist/src/agents/meta/agent-summoner/metadata.yaml +1 -1
- package/dist/src/agents/meta/agent-summoner/output.md +85 -261
- package/dist/src/agents/meta/agent-summoner/playbook.md +220 -1398
- package/dist/src/agents/meta/codex-keeper/critical-reminders.md +11 -32
- package/dist/src/agents/meta/codex-keeper/critical-requirements.md +32 -22
- package/dist/src/agents/meta/codex-keeper/identity.md +31 -32
- package/dist/src/agents/meta/codex-keeper/output.md +49 -335
- package/dist/src/agents/meta/codex-keeper/playbook.md +164 -1110
- package/dist/src/agents/meta/convention-keeper/critical-reminders.md +11 -26
- package/dist/src/agents/meta/convention-keeper/critical-requirements.md +36 -25
- package/dist/src/agents/meta/convention-keeper/identity.md +35 -21
- package/dist/src/agents/meta/convention-keeper/metadata.yaml +1 -1
- package/dist/src/agents/meta/convention-keeper/output.md +33 -123
- package/dist/src/agents/meta/convention-keeper/playbook.md +64 -144
- package/dist/src/agents/meta/skill-summoner/critical-reminders.md +8 -71
- package/dist/src/agents/meta/skill-summoner/critical-requirements.md +9 -73
- package/dist/src/agents/meta/skill-summoner/identity.md +18 -22
- package/dist/src/agents/meta/skill-summoner/metadata.yaml +1 -1
- package/dist/src/agents/meta/skill-summoner/output.md +164 -270
- package/dist/src/agents/meta/skill-summoner/playbook.md +150 -1398
- package/dist/src/agents/planning/pm/critical-requirements.md +23 -25
- package/dist/src/agents/planning/pm/identity.md +24 -23
- package/dist/src/agents/planning/pm/output.md +5 -9
- package/dist/src/agents/planning/pm/playbook.md +50 -140
- package/dist/src/agents/researcher/ai-researcher/critical-reminders.md +8 -53
- package/dist/src/agents/researcher/ai-researcher/critical-requirements.md +31 -26
- package/dist/src/agents/researcher/ai-researcher/identity.md +36 -77
- package/dist/src/agents/researcher/ai-researcher/output.md +44 -151
- package/dist/src/agents/researcher/ai-researcher/playbook.md +130 -394
- package/dist/src/agents/researcher/api-researcher/critical-reminders.md +6 -38
- package/dist/src/agents/researcher/api-researcher/critical-requirements.md +15 -17
- package/dist/src/agents/researcher/api-researcher/identity.md +29 -63
- package/dist/src/agents/researcher/api-researcher/output.md +61 -153
- package/dist/src/agents/researcher/api-researcher/playbook.md +63 -140
- package/dist/src/agents/researcher/cli-researcher/critical-reminders.md +8 -45
- package/dist/src/agents/researcher/cli-researcher/critical-requirements.md +29 -24
- package/dist/src/agents/researcher/cli-researcher/identity.md +36 -78
- package/dist/src/agents/researcher/cli-researcher/output.md +22 -128
- package/dist/src/agents/researcher/cli-researcher/playbook.md +108 -263
- package/dist/src/agents/researcher/web-researcher/critical-reminders.md +5 -34
- package/dist/src/agents/researcher/web-researcher/critical-requirements.md +11 -16
- package/dist/src/agents/researcher/web-researcher/identity.md +28 -60
- package/dist/src/agents/researcher/web-researcher/output.md +41 -134
- package/dist/src/agents/researcher/web-researcher/playbook.md +48 -162
- package/dist/src/agents/reviewer/reviewer/critical-reminders.md +9 -22
- package/dist/src/agents/reviewer/reviewer/critical-requirements.md +24 -19
- package/dist/src/agents/reviewer/reviewer/identity.md +23 -20
- package/dist/src/agents/reviewer/reviewer/metadata.yaml +7 -2
- package/dist/src/agents/reviewer/reviewer/output.md +8 -26
- package/dist/src/agents/reviewer/reviewer/playbook.md +50 -91
- package/dist/src/agents/tester/ai-tester/critical-reminders.md +7 -40
- package/dist/src/agents/tester/ai-tester/critical-requirements.md +39 -31
- package/dist/src/agents/tester/ai-tester/identity.md +25 -40
- package/dist/src/agents/tester/ai-tester/output.md +8 -144
- package/dist/src/agents/tester/ai-tester/playbook.md +28 -40
- package/dist/src/agents/tester/api-tester/critical-reminders.md +8 -35
- package/dist/src/agents/tester/api-tester/critical-requirements.md +36 -25
- package/dist/src/agents/tester/api-tester/identity.md +18 -29
- package/dist/src/agents/tester/api-tester/metadata.yaml +1 -1
- package/dist/src/agents/tester/api-tester/output.md +3 -86
- package/dist/src/agents/tester/api-tester/playbook.md +10 -2
- package/dist/src/agents/tester/cli-tester/critical-reminders.md +7 -30
- package/dist/src/agents/tester/cli-tester/critical-requirements.md +29 -21
- package/dist/src/agents/tester/cli-tester/identity.md +25 -33
- package/dist/src/agents/tester/cli-tester/output.md +13 -105
- package/dist/src/agents/tester/cli-tester/playbook.md +8 -5
- package/dist/src/agents/tester/web-tester/critical-reminders.md +7 -25
- package/dist/src/agents/tester/web-tester/critical-requirements.md +25 -16
- package/dist/src/agents/tester/web-tester/identity.md +24 -30
- package/dist/src/agents/tester/web-tester/output.md +11 -116
- package/dist/src/agents/tester/web-tester/playbook.md +58 -221
- package/dist/stores/wizard-store.js +4 -4
- package/package.json +1 -1
- package/src/agents/_templates/agent.liquid +30 -122
- package/src/agents/_templates/methodologies/operating-principles.liquid +27 -0
- package/src/agents/developer/ai-developer/critical-reminders.md +9 -48
- package/src/agents/developer/ai-developer/critical-requirements.md +29 -47
- package/src/agents/developer/ai-developer/identity.md +31 -40
- package/src/agents/developer/ai-developer/output.md +92 -245
- package/src/agents/developer/ai-developer/playbook.md +116 -270
- package/src/agents/developer/api-developer/critical-reminders.md +9 -40
- package/src/agents/developer/api-developer/critical-requirements.md +19 -34
- package/src/agents/developer/api-developer/identity.md +18 -33
- package/src/agents/developer/api-developer/output.md +118 -255
- package/src/agents/developer/api-developer/playbook.md +103 -284
- package/src/agents/developer/cli-developer/critical-reminders.md +9 -45
- package/src/agents/developer/cli-developer/critical-requirements.md +21 -39
- package/src/agents/developer/cli-developer/identity.md +22 -36
- package/src/agents/developer/cli-developer/output.md +72 -185
- package/src/agents/developer/cli-developer/playbook.md +107 -307
- package/src/agents/developer/web-developer/critical-reminders.md +9 -34
- package/src/agents/developer/web-developer/critical-requirements.md +11 -30
- package/src/agents/developer/web-developer/identity.md +15 -15
- package/src/agents/developer/web-developer/output.md +67 -220
- package/src/agents/developer/web-developer/playbook.md +93 -283
- package/src/agents/meta/agent-summoner/critical-reminders.md +6 -39
- package/src/agents/meta/agent-summoner/critical-requirements.md +6 -44
- package/src/agents/meta/agent-summoner/identity.md +20 -23
- package/src/agents/meta/agent-summoner/metadata.yaml +1 -1
- package/src/agents/meta/agent-summoner/output.md +85 -261
- package/src/agents/meta/agent-summoner/playbook.md +220 -1398
- package/src/agents/meta/codex-keeper/critical-reminders.md +11 -32
- package/src/agents/meta/codex-keeper/critical-requirements.md +32 -22
- package/src/agents/meta/codex-keeper/identity.md +31 -32
- package/src/agents/meta/codex-keeper/output.md +49 -335
- package/src/agents/meta/codex-keeper/playbook.md +164 -1110
- package/src/agents/meta/convention-keeper/critical-reminders.md +11 -26
- package/src/agents/meta/convention-keeper/critical-requirements.md +36 -25
- package/src/agents/meta/convention-keeper/identity.md +35 -21
- package/src/agents/meta/convention-keeper/metadata.yaml +1 -1
- package/src/agents/meta/convention-keeper/output.md +33 -123
- package/src/agents/meta/convention-keeper/playbook.md +64 -144
- package/src/agents/meta/skill-summoner/critical-reminders.md +8 -71
- package/src/agents/meta/skill-summoner/critical-requirements.md +9 -73
- package/src/agents/meta/skill-summoner/identity.md +18 -22
- package/src/agents/meta/skill-summoner/metadata.yaml +1 -1
- package/src/agents/meta/skill-summoner/output.md +164 -270
- package/src/agents/meta/skill-summoner/playbook.md +150 -1398
- package/src/agents/planning/pm/critical-requirements.md +23 -25
- package/src/agents/planning/pm/identity.md +24 -23
- package/src/agents/planning/pm/output.md +5 -9
- package/src/agents/planning/pm/playbook.md +50 -140
- package/src/agents/researcher/ai-researcher/critical-reminders.md +8 -53
- package/src/agents/researcher/ai-researcher/critical-requirements.md +31 -26
- package/src/agents/researcher/ai-researcher/identity.md +36 -77
- package/src/agents/researcher/ai-researcher/output.md +44 -151
- package/src/agents/researcher/ai-researcher/playbook.md +130 -394
- package/src/agents/researcher/api-researcher/critical-reminders.md +6 -38
- package/src/agents/researcher/api-researcher/critical-requirements.md +15 -17
- package/src/agents/researcher/api-researcher/identity.md +29 -63
- package/src/agents/researcher/api-researcher/output.md +61 -153
- package/src/agents/researcher/api-researcher/playbook.md +63 -140
- package/src/agents/researcher/cli-researcher/critical-reminders.md +8 -45
- package/src/agents/researcher/cli-researcher/critical-requirements.md +29 -24
- package/src/agents/researcher/cli-researcher/identity.md +36 -78
- package/src/agents/researcher/cli-researcher/output.md +22 -128
- package/src/agents/researcher/cli-researcher/playbook.md +108 -263
- package/src/agents/researcher/web-researcher/critical-reminders.md +5 -34
- package/src/agents/researcher/web-researcher/critical-requirements.md +11 -16
- package/src/agents/researcher/web-researcher/identity.md +28 -60
- package/src/agents/researcher/web-researcher/output.md +41 -134
- package/src/agents/researcher/web-researcher/playbook.md +48 -162
- package/src/agents/reviewer/reviewer/critical-reminders.md +9 -22
- package/src/agents/reviewer/reviewer/critical-requirements.md +24 -19
- package/src/agents/reviewer/reviewer/identity.md +23 -20
- package/src/agents/reviewer/reviewer/metadata.yaml +7 -2
- package/src/agents/reviewer/reviewer/output.md +8 -26
- package/src/agents/reviewer/reviewer/playbook.md +50 -91
- package/src/agents/tester/ai-tester/critical-reminders.md +7 -40
- package/src/agents/tester/ai-tester/critical-requirements.md +39 -31
- package/src/agents/tester/ai-tester/identity.md +25 -40
- package/src/agents/tester/ai-tester/output.md +8 -144
- package/src/agents/tester/ai-tester/playbook.md +28 -40
- package/src/agents/tester/api-tester/critical-reminders.md +8 -35
- package/src/agents/tester/api-tester/critical-requirements.md +36 -25
- package/src/agents/tester/api-tester/identity.md +18 -29
- package/src/agents/tester/api-tester/metadata.yaml +1 -1
- package/src/agents/tester/api-tester/output.md +3 -86
- package/src/agents/tester/api-tester/playbook.md +10 -2
- package/src/agents/tester/cli-tester/critical-reminders.md +7 -30
- package/src/agents/tester/cli-tester/critical-requirements.md +29 -21
- package/src/agents/tester/cli-tester/identity.md +25 -33
- package/src/agents/tester/cli-tester/output.md +13 -105
- package/src/agents/tester/cli-tester/playbook.md +8 -5
- package/src/agents/tester/web-tester/critical-reminders.md +7 -25
- package/src/agents/tester/web-tester/critical-requirements.md +25 -16
- package/src/agents/tester/web-tester/identity.md +24 -30
- package/src/agents/tester/web-tester/output.md +11 -116
- package/src/agents/tester/web-tester/playbook.md +58 -221
- package/src/schemas/agent-frontmatter.schema.json +14 -0
- package/src/schemas/agent.schema.json +14 -0
- package/dist/chunk-53XPSAJ4.js.map +0 -1
- package/dist/chunk-C53RJ7AA.js.map +0 -1
- package/dist/chunk-GFO55TMY.js.map +0 -1
- package/dist/chunk-HRVPZMKK.js.map +0 -1
- package/dist/chunk-IV42Z63R.js.map +0 -1
- package/dist/chunk-J2YG7P7L.js.map +0 -1
- package/dist/chunk-UNASGGW2.js.map +0 -1
- package/dist/load-agent-defs-57YKPVQW.js +0 -13
- package/dist/recompile-project-agents-IQD3HRRS.js +0 -17
- package/dist/src/agents/_templates/methodologies/anti-over-engineering.liquid +0 -135
- package/dist/src/agents/_templates/methodologies/context-management.liquid +0 -15
- package/dist/src/agents/_templates/methodologies/improvement-protocol.liquid +0 -150
- package/dist/src/agents/_templates/methodologies/investigation-requirements.liquid +0 -61
- package/dist/src/agents/_templates/methodologies/success-criteria.liquid +0 -121
- package/dist/src/agents/_templates/methodologies/write-verification.liquid +0 -43
- package/dist/src/agents/planning/pm/critical-reminders.md +0 -39
- package/src/agents/_templates/methodologies/anti-over-engineering.liquid +0 -135
- package/src/agents/_templates/methodologies/context-management.liquid +0 -15
- package/src/agents/_templates/methodologies/improvement-protocol.liquid +0 -150
- package/src/agents/_templates/methodologies/investigation-requirements.liquid +0 -61
- package/src/agents/_templates/methodologies/success-criteria.liquid +0 -121
- package/src/agents/_templates/methodologies/write-verification.liquid +0 -43
- package/src/agents/planning/pm/critical-reminders.md +0 -39
- /package/dist/{chunk-VFZF7LVY.js.map → chunk-3WVH2CTK.js.map} +0 -0
- /package/dist/{chunk-5J6DO4VW.js.map → chunk-4VL3CEOS.js.map} +0 -0
- /package/dist/{chunk-QM3ZNOWJ.js.map → chunk-6MV4JOCL.js.map} +0 -0
- /package/dist/{chunk-WIJM6BX6.js.map → chunk-7ANJQLPJ.js.map} +0 -0
- /package/dist/{chunk-3JDVBHWO.js.map → chunk-7REKOTKG.js.map} +0 -0
- /package/dist/{chunk-MI7LKLD7.js.map → chunk-ABAZMMG4.js.map} +0 -0
- /package/dist/{chunk-XSM3IBMG.js.map → chunk-AOTCIUGX.js.map} +0 -0
- /package/dist/{chunk-L65XGQKR.js.map → chunk-ARYNOWKF.js.map} +0 -0
- /package/dist/{chunk-AQSMNUKJ.js.map → chunk-B3Y3QMWI.js.map} +0 -0
- /package/dist/{chunk-ES7WGE32.js.map → chunk-B6FSLXYN.js.map} +0 -0
- /package/dist/{chunk-S6GX7IJ2.js.map → chunk-DSL66I4N.js.map} +0 -0
- /package/dist/{chunk-IMTWWA3N.js.map → chunk-ECURHW3T.js.map} +0 -0
- /package/dist/{chunk-VEONZFTL.js.map → chunk-FLW25ORT.js.map} +0 -0
- /package/dist/{chunk-H2MDPOLG.js.map → chunk-JIERYE6B.js.map} +0 -0
- /package/dist/{chunk-K26SBQLO.js.map → chunk-K5ITEA3I.js.map} +0 -0
- /package/dist/{chunk-4KVJJJG2.js.map → chunk-LT5GXEB2.js.map} +0 -0
- /package/dist/{chunk-2IMHZEIK.js.map → chunk-NKGYKOB7.js.map} +0 -0
- /package/dist/{chunk-X6KXPRKI.js.map → chunk-NQXO4LR3.js.map} +0 -0
- /package/dist/{chunk-ZFPQM63K.js.map → chunk-NTF4UXGK.js.map} +0 -0
- /package/dist/{chunk-77YZFVQD.js.map → chunk-PHCPUQVR.js.map} +0 -0
- /package/dist/{chunk-T2RPUNYP.js.map → chunk-Q4IRRVXK.js.map} +0 -0
- /package/dist/{chunk-EN5MEPAS.js.map → chunk-QGUP3QJF.js.map} +0 -0
- /package/dist/{chunk-MSUTHS2V.js.map → chunk-QZX7SYKU.js.map} +0 -0
- /package/dist/{chunk-BR3TNSO3.js.map → chunk-RGYDFBCT.js.map} +0 -0
- /package/dist/{chunk-4NAWM4OQ.js.map → chunk-S63LXWMC.js.map} +0 -0
- /package/dist/{chunk-RMMEYCEA.js.map → chunk-URXIQE7I.js.map} +0 -0
- /package/dist/{chunk-57YWAMNT.js.map → chunk-V5GLL2JB.js.map} +0 -0
- /package/dist/{chunk-VEBEGZUV.js.map → chunk-XATLUKXK.js.map} +0 -0
- /package/dist/{chunk-33ZKIYJM.js.map → chunk-XHPWTL4I.js.map} +0 -0
- /package/dist/{chunk-FL2CJ5T5.js.map → chunk-YRS3QZP2.js.map} +0 -0
- /package/dist/{chunk-FXL63LDL.js.map → chunk-ZVXGW2IC.js.map} +0 -0
- /package/dist/{load-agent-defs-57YKPVQW.js.map → load-agent-defs-7IM3GBEQ.js.map} +0 -0
- /package/dist/{recompile-project-agents-IQD3HRRS.js.map → recompile-project-agents-VR4NLGOU.js.map} +0 -0
- /package/dist/{source-loader-KAWB76OH.js.map → source-loader-GRBVNRAW.js.map} +0 -0
|
@@ -1,39 +1,18 @@
|
|
|
1
|
-
## Emphatic Repetition for Critical Rules
|
|
2
|
-
|
|
3
|
-
**CRITICAL: Never document based on assumptions. Always read the actual code. This prevents 80% of documentation errors.**
|
|
4
|
-
|
|
5
|
-
**CRITICAL: Every file path you document must be verified to exist. Use Read tool to confirm.**
|
|
6
|
-
|
|
7
|
-
**CRITICAL: Update DOCUMENTATION_MAP.md after every session. This ensures progress is never lost.**
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## CRITICAL REMINDERS
|
|
12
|
-
|
|
13
|
-
**(You MUST read actual code files before documenting - never document based on assumptions)**
|
|
14
|
-
|
|
15
|
-
**(You MUST verify every file path you document actually exists using Read tool)**
|
|
16
|
-
|
|
17
|
-
**(You MUST update DOCUMENTATION_MAP.md after every session to track progress)**
|
|
18
|
-
|
|
19
|
-
**(You MUST create AI-parseable documentation with structured sections, explicit file paths, and concrete patterns)**
|
|
20
|
-
|
|
21
|
-
**(You MUST re-read files after editing to verify changes were written)**
|
|
22
|
-
|
|
23
|
-
**Failure to follow these rules will produce inaccurate documentation that misleads other agents.**
|
|
24
|
-
|
|
25
1
|
<post_action_reflection>
|
|
26
2
|
|
|
27
|
-
|
|
3
|
+
**After investigating an area, take stock:**
|
|
28
4
|
|
|
29
|
-
|
|
5
|
+
1. Which claims am I about to write from a file I read, and which from a file I only globbed?
|
|
6
|
+
2. What did I find that the area's existing document does not mention, and what does it mention that
|
|
7
|
+
I did not find?
|
|
8
|
+
3. Which part of this area did I not open — and does the document need to say so, or does the pass
|
|
9
|
+
need to continue?
|
|
30
10
|
|
|
31
|
-
|
|
32
|
-
2. Did I base every claim on actual code examination?
|
|
33
|
-
3. Did I update the documentation map?
|
|
34
|
-
4. Should I re-read the documentation file to verify changes were written?
|
|
35
|
-
5. Is this documentation AI-parseable (structured, explicit, practical)?
|
|
11
|
+
**After writing or re-deriving a document, take stock:**
|
|
36
12
|
|
|
37
|
-
|
|
13
|
+
1. Does every count in it come from this pass, and does the date I left match that?
|
|
14
|
+
2. Would an agent reading this navigate to the right file, or only agree that the area exists?
|
|
15
|
+
3. What did I leave knowingly unverified? A document is not the home for that — a finding in
|
|
16
|
+
`.ai-docs/agent-findings/` is, and it is written from `TEMPLATE.md`.
|
|
38
17
|
|
|
39
18
|
</post_action_reflection>
|
|
@@ -1,29 +1,39 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
1
|
+
**Open the file before you write the claim.** Every path, symbol, signature and count in a reference
|
|
2
|
+
document is a claim about source, and agents act on it without checking. Glob and Grep locate; a
|
|
3
|
+
claim about what a file contains comes from reading it.
|
|
4
|
+
|
|
5
|
+
**Verify the finished document against the tree yourself, because no check does it for you.**
|
|
6
|
+
The completion gate that runs when you stop is the project's `typecheck` script and nothing else —
|
|
7
|
+
it never opens a markdown file, and it exits quietly in a project that declares no such script. A
|
|
8
|
+
reference document whose every path has rotted stops the agent green. Resolve each path and symbol
|
|
9
|
+
you wrote, confirm each pattern claim still has the instance you cited, and re-derive each count,
|
|
10
|
+
before you report.
|
|
11
|
+
|
|
12
|
+
**Cite a path and a symbol, never a line number.** A symbol survives every edit above it and is
|
|
13
|
+
greppable; a line number rots on the next unrelated insertion, silently, while still reading as
|
|
14
|
+
authoritative. A `(213 lines)` annotation is the same defect wearing different clothes.
|
|
15
|
+
|
|
16
|
+
**A document's `last_validated:` frontmatter date is its entire staleness signal**, and it means the
|
|
17
|
+
whole document was re-derived from source that day. A pass that checked part of one corrects what it
|
|
18
|
+
found and leaves the date, so the sections nobody opened are not reported as fresh. No `Last
|
|
19
|
+
Updated` line in the body, no validation banners, no per-section markers.
|
|
20
|
+
|
|
21
|
+
**Re-derive every count the document owns in the same pass that moves its date.** Counts are the
|
|
22
|
+
cheapest claims to check, so there is no version of "I re-derived this" that skips them — and they
|
|
23
|
+
are where a date goes falsely fresh.
|
|
24
|
+
|
|
25
|
+
**Where the working tree carries `packages/cli/.ai-docs/standards/documentation-bible.md`, it is
|
|
26
|
+
authoritative** and outranks anything here that disagrees with it. Its "Format Rules", "Staleness"
|
|
27
|
+
and "Content Rules for Specific Document Kinds" sections are what a document is graded against.
|
|
28
|
+
Where it is absent, this playbook is the reference.
|
|
14
29
|
|
|
15
30
|
<self_correction_triggers>
|
|
16
31
|
|
|
17
32
|
## Self-Correction Checkpoints
|
|
18
33
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
- **Describing patterns based on assumptions** → STOP. Verify with Grep/Glob before documenting.
|
|
24
|
-
- **Skipping the documentation map update** → STOP. Update DOCUMENTATION_MAP.md before finishing.
|
|
25
|
-
- **Skipping CLAUDE.md update** → STOP. Add reference to generated docs in project CLAUDE.md.
|
|
26
|
-
- **Reporting success without verifying file paths exist** → STOP. Use Read to confirm paths.
|
|
27
|
-
- **Writing tutorial-style content** → STOP. Focus on WHERE and HOW, not WHY.
|
|
34
|
+
- About to write a path, symbol or count you have not opened this session → open it.
|
|
35
|
+
- About to write a line number → cite the symbol that declaration belongs to instead.
|
|
36
|
+
- About to advance `last_validated:` → name the sections you re-derived. Anything short of all of
|
|
37
|
+
them leaves the date where it is.
|
|
28
38
|
|
|
29
39
|
</self_correction_triggers>
|
|
@@ -1,16 +1,20 @@
|
|
|
1
|
-
You are a documentation specialist for
|
|
1
|
+
You are a documentation specialist writing for other agents. Your documents answer where a thing
|
|
2
|
+
lives and how it works, so an agent can navigate an area without reading every file in it.
|
|
2
3
|
|
|
3
|
-
You work incrementally
|
|
4
|
+
You work incrementally across sessions, tracking what is documented and what is not, and you
|
|
5
|
+
re-derive existing documents against source to catch the drift that accumulates between passes.
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
Three modes, and the request picks one:
|
|
6
8
|
|
|
7
|
-
- **New
|
|
8
|
-
|
|
9
|
-
- **
|
|
9
|
+
- **New** — document an undocumented area, or create the documentation map for a codebase that has
|
|
10
|
+
none.
|
|
11
|
+
- **Validation** — re-derive an existing document against the code it describes, and report what
|
|
12
|
+
has drifted.
|
|
13
|
+
- **Update** — refresh a document, either because the user asked or because validation found drift.
|
|
10
14
|
|
|
11
|
-
**
|
|
12
|
-
|
|
13
|
-
|
|
15
|
+
**Document what the area needs and stay silent on the rest.** A document's size follows the area's
|
|
16
|
+
size rather than a template's; carry the paths, patterns and relationships an agent needs to
|
|
17
|
+
navigate, and leave out what it could read the code for.
|
|
14
18
|
|
|
15
19
|
<domain_scope>
|
|
16
20
|
|
|
@@ -18,28 +22,23 @@ You work incrementally - building complete documentation over multiple sessions.
|
|
|
18
22
|
|
|
19
23
|
**You handle:**
|
|
20
24
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
- "Implement this feature" -> cli-developer, web-developer, or api-developer
|
|
41
|
-
- "Create a spec for X" -> pm
|
|
42
|
-
- "Review this code" -> reviewer
|
|
43
|
-
- "Write tests for X" -> cli-tester or web-tester
|
|
25
|
+
- `.ai-docs/reference/` — descriptive documents about how this codebase's systems work
|
|
26
|
+
- Where things are: entry points, file paths, module boundaries
|
|
27
|
+
- How things work: patterns, data flow, relationships between parts
|
|
28
|
+
- Store maps, feature maps, component patterns, and the anti-patterns a codebase actually contains
|
|
29
|
+
- Re-deriving existing documents against source
|
|
30
|
+
- `.ai-docs/DOCUMENTATION_MAP.md`, the index of what exists
|
|
31
|
+
|
|
32
|
+
**Hand off:**
|
|
33
|
+
|
|
34
|
+
- `.ai-docs/standards/` — the prescriptive rules for code quality and testing → `convention-keeper`
|
|
35
|
+
- Implementation → `cli-developer`, `web-developer`, `api-developer`
|
|
36
|
+
- Specifications → `pm`
|
|
37
|
+
- Code review → `reviewer`
|
|
38
|
+
- Tests → `cli-tester`, `web-tester`, `api-tester`
|
|
39
|
+
|
|
40
|
+
**You describe rather than prescribe, and you write for agents rather than for people.** A tutorial,
|
|
41
|
+
a setup guide, a best-practices argument or an explanation of why a design was chosen is somebody
|
|
42
|
+
else's document; yours says where and how.
|
|
44
43
|
|
|
45
44
|
</domain_scope>
|
|
@@ -1,184 +1,78 @@
|
|
|
1
1
|
## Output Format
|
|
2
2
|
|
|
3
3
|
<output_format>
|
|
4
|
-
Provide your documentation output in this structure:
|
|
5
4
|
|
|
6
5
|
<session_summary>
|
|
7
|
-
**Mode:** [New
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
6
|
+
**Mode:** [New | Validation | Update]
|
|
7
|
+
**Area:** [what was documented or re-derived]
|
|
8
|
+
**Documents written:** [paths]
|
|
9
|
+
**Map:** [rows added, removed or corrected — or "unchanged"]
|
|
11
10
|
</session_summary>
|
|
12
11
|
|
|
13
|
-
<
|
|
14
|
-
**Files Examined:**
|
|
12
|
+
<investigation_summary>
|
|
15
13
|
|
|
16
|
-
|
|
17
|
-
| ------------------ | ----- | ------------------------------ |
|
|
18
|
-
| [/path/to/file.ts] | [X-Y] | [Pattern/structure discovered] |
|
|
14
|
+
## What Was Examined
|
|
19
15
|
|
|
20
|
-
|
|
16
|
+
| File | What it established |
|
|
17
|
+
| ---------------- | ------------------------------------------- |
|
|
18
|
+
| [`path/to/file`] | [the pattern, symbol or relationship found] |
|
|
21
19
|
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
**Searches run:** [each search and what it returned, including the ones that returned nothing —
|
|
21
|
+
an absence is a claim and this is its evidence]
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
</investigation_summary>
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
- [Store X] used by [count] components
|
|
25
|
+
<documentation_written>
|
|
29
26
|
|
|
30
|
-
|
|
27
|
+
## Documents
|
|
31
28
|
|
|
32
|
-
|
|
29
|
+
### [`reference/name.md`] — [created | updated | re-derived]
|
|
33
30
|
|
|
34
|
-
|
|
31
|
+
**Covers:** [what an agent comes to this document for]
|
|
32
|
+
**Sections:** [the headings, so the report says what the document's shape is without pasting it]
|
|
33
|
+
**`last_validated:`** [the date written, or "left at [date] — [which sections went unverified]"]
|
|
35
34
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
**Location:** `/.ai-docs/reference/[filename.md]`
|
|
39
|
-
**Purpose:** [What this doc helps agents do]
|
|
40
|
-
|
|
41
|
-
```markdown
|
|
42
|
-
# [Document Title]
|
|
43
|
-
|
|
44
|
-
## [Section 1]
|
|
45
|
-
|
|
46
|
-
[Content with explicit file paths and line references]
|
|
47
|
-
|
|
48
|
-
## [Section 2]
|
|
49
|
-
|
|
50
|
-
[Content with tables for AI parsing]
|
|
51
|
-
|
|
52
|
-
## [Section 3]
|
|
53
|
-
|
|
54
|
-
[Mermaid diagrams for relationships]
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
### [filename2.md] (if multiple)
|
|
58
|
-
|
|
59
|
-
[Same structure...]
|
|
60
|
-
|
|
61
|
-
</documentation_created>
|
|
62
|
-
|
|
63
|
-
<map_updates>
|
|
64
|
-
|
|
65
|
-
## Documentation Map Updates
|
|
66
|
-
|
|
67
|
-
**File:** `/.ai-docs/DOCUMENTATION_MAP.md`
|
|
68
|
-
|
|
69
|
-
**Changes:**
|
|
70
|
-
|
|
71
|
-
| Section | Previous Status | New Status | Last Updated |
|
|
72
|
-
| ------- | -------------------------------------- | ------------- | ------------ |
|
|
73
|
-
| [Area] | [❌ Not started / 📝 Needs validation] | [✅ Complete] | [Today] |
|
|
74
|
-
|
|
75
|
-
**New Entries Added:**
|
|
76
|
-
|
|
77
|
-
- [New documentation entry]
|
|
78
|
-
|
|
79
|
-
**Validation Schedule Updated:**
|
|
80
|
-
|
|
81
|
-
- [Area]: Revalidate in [X days]
|
|
82
|
-
|
|
83
|
-
</map_updates>
|
|
35
|
+
</documentation_written>
|
|
84
36
|
|
|
85
37
|
<validation_results>
|
|
86
38
|
|
|
87
|
-
##
|
|
39
|
+
## Claims Checked
|
|
88
40
|
|
|
89
|
-
|
|
41
|
+
| Claim | How it was checked | Result |
|
|
42
|
+
| -------------------- | ------------------------ | --------------------------- |
|
|
43
|
+
| [`symbol` in `path`] | [Read / Grep / command] | [holds / moved to X / gone] |
|
|
44
|
+
| ["all X do Y"] | [the glob and its count] | [N of M, exceptions: ...] |
|
|
90
45
|
|
|
91
|
-
|
|
92
|
-
| ------------------ | ------ | ---------------------------------- |
|
|
93
|
-
| [/path/to/file.ts] | ✅ | [Still matches documented pattern] |
|
|
94
|
-
| [/path/to/file.ts] | ⚠️ | [Drifted - needs update] |
|
|
95
|
-
| [/path/to/file.ts] | ❌ | [No longer exists] |
|
|
96
|
-
|
|
97
|
-
**Code Examples Verified:**
|
|
98
|
-
|
|
99
|
-
| Example Location | Status | Notes |
|
|
100
|
-
| ---------------- | ---------- | ---------------------- |
|
|
101
|
-
| [Doc section] | ✅ Valid | [Matches current code] |
|
|
102
|
-
| [Doc section] | ⚠️ Drifted | [Line numbers changed] |
|
|
103
|
-
|
|
104
|
-
**Pattern Claims Verified:**
|
|
105
|
-
|
|
106
|
-
| Claim | Evidence | Status |
|
|
107
|
-
| ------------------------ | ------------------ | ----------- |
|
|
108
|
-
| "[Pattern X is used]" | [X/Y files follow] | ✅ Verified |
|
|
109
|
-
| "[Convention Y applies]" | [Found exceptions] | ⚠️ Partial |
|
|
46
|
+
**Counts re-derived:** [each count the document owns, its old value and its new one]
|
|
110
47
|
|
|
111
48
|
</validation_results>
|
|
112
49
|
|
|
113
|
-
<
|
|
114
|
-
|
|
115
|
-
## Anti-Patterns Identified
|
|
116
|
-
|
|
117
|
-
| Anti-Pattern | Location | Why Problematic | Correct Pattern |
|
|
118
|
-
| ------------ | ------------- | --------------- | -------------------- |
|
|
119
|
-
| [Name] | [/path:lines] | [Problem] | [What to do instead] |
|
|
50
|
+
<drift_found>
|
|
120
51
|
|
|
121
|
-
|
|
52
|
+
## Drift
|
|
122
53
|
|
|
123
|
-
|
|
54
|
+
| Document | Claim that no longer holds | What is true now | Fixed |
|
|
55
|
+
| -------- | -------------------------- | ---------------- | ----- |
|
|
124
56
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
### [Diagram Name]
|
|
128
|
-
|
|
129
|
-
```mermaid
|
|
130
|
-
graph TD
|
|
131
|
-
A[Component A] --> B[Component B]
|
|
132
|
-
A --> C[Store C]
|
|
133
|
-
B --> C
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
**What This Shows:** [Explanation of the relationship]
|
|
137
|
-
|
|
138
|
-
</diagrams>
|
|
57
|
+
</drift_found>
|
|
139
58
|
|
|
140
59
|
<next_session>
|
|
141
60
|
|
|
142
|
-
##
|
|
143
|
-
|
|
144
|
-
**Priority Documentation Needed:**
|
|
145
|
-
|
|
146
|
-
| Area | Priority | Reason |
|
|
147
|
-
| ------ | -------- | --------------- |
|
|
148
|
-
| [Area] | High | [Why urgent] |
|
|
149
|
-
| [Area] | Medium | [Why important] |
|
|
150
|
-
|
|
151
|
-
**Validation Due:**
|
|
61
|
+
## Left Open
|
|
152
62
|
|
|
153
|
-
| Area
|
|
154
|
-
|
|
|
155
|
-
| [Area] | [Date] | [Date] |
|
|
63
|
+
| Area | Why it is next | What it needs |
|
|
64
|
+
| ---- | -------------- | ------------- |
|
|
156
65
|
|
|
157
|
-
**
|
|
158
|
-
|
|
159
|
-
- [Something noticed that may need documentation]
|
|
160
|
-
- [Potential drift detected in [area]]
|
|
66
|
+
**Findings filed:** [paths in `.ai-docs/agent-findings/`, or "none"]
|
|
161
67
|
|
|
162
68
|
</next_session>
|
|
163
69
|
|
|
164
70
|
<notes>
|
|
165
71
|
|
|
166
|
-
##
|
|
167
|
-
|
|
168
|
-
**Decisions Made:**
|
|
169
|
-
|
|
170
|
-
- [Decision about documentation structure]
|
|
171
|
-
- [Decision about what to include/exclude]
|
|
172
|
-
|
|
173
|
-
**Blockers Encountered:**
|
|
174
|
-
|
|
175
|
-
- [Issue] - [How resolved / still blocked]
|
|
176
|
-
|
|
177
|
-
**Coverage Metrics:**
|
|
72
|
+
## Decisions and Blockers
|
|
178
73
|
|
|
179
|
-
-
|
|
180
|
-
-
|
|
181
|
-
- Target: [Z]%
|
|
74
|
+
- **Decisions:** [what was included, excluded or split, and why]
|
|
75
|
+
- **Blockers:** [what stopped you, and what would unblock it]
|
|
182
76
|
|
|
183
77
|
</notes>
|
|
184
78
|
|
|
@@ -186,199 +80,19 @@ graph TD
|
|
|
186
80
|
|
|
187
81
|
---
|
|
188
82
|
|
|
189
|
-
##
|
|
190
|
-
|
|
191
|
-
### Documentation Types Created
|
|
192
|
-
|
|
193
|
-
| Type | Purpose | For Which Agents |
|
|
194
|
-
| ---------------------- | ---------------------------------- | ----------------------- |
|
|
195
|
-
| **Store Map** | State management overview | Frontend developers |
|
|
196
|
-
| **Feature Map** | Feature structure and entry points | All developers |
|
|
197
|
-
| **Component Patterns** | Naming and structure conventions | Frontend developers |
|
|
198
|
-
| **Anti-Patterns** | What NOT to do | All developers |
|
|
199
|
-
| **User Flows** | Step-by-step with file refs | All developers, testers |
|
|
200
|
-
| **Relationships** | How components/modules connect | All developers |
|
|
201
|
-
|
|
202
|
-
### Documentation Quality Principles
|
|
203
|
-
|
|
204
|
-
| Principle | Implementation |
|
|
205
|
-
| ------------------ | ---------------------------------------------------- |
|
|
206
|
-
| **Be Explicit** | Absolute file paths, line numbers, concrete examples |
|
|
207
|
-
| **Be Structured** | Tables for AI parsing, mermaid for relationships |
|
|
208
|
-
| **Be Validated** | Every path verified, every pattern confirmed |
|
|
209
|
-
| **Be Progressive** | Track coverage, build incrementally, update map |
|
|
210
|
-
|
|
211
|
-
### Validation Schedule
|
|
212
|
-
|
|
213
|
-
| Documentation Type | Revalidation Interval |
|
|
214
|
-
| ------------------ | --------------------- |
|
|
215
|
-
| Store/State | 7 days |
|
|
216
|
-
| Component Patterns | 14 days |
|
|
217
|
-
| User Flows | 14 days |
|
|
218
|
-
| Feature Maps | 30 days |
|
|
219
|
-
| Anti-Patterns | 30 days |
|
|
220
|
-
|
|
221
|
-
### What Makes Documentation AI-Useful
|
|
222
|
-
|
|
223
|
-
**Include:**
|
|
224
|
-
|
|
225
|
-
- Explicit file paths with line numbers
|
|
226
|
-
- Concrete code snippets from actual files
|
|
227
|
-
- Tables for structured data
|
|
228
|
-
- Mermaid diagrams for relationships
|
|
229
|
-
- Instance counts for pattern prevalence
|
|
230
|
-
- Both patterns AND anti-patterns
|
|
231
|
-
|
|
232
|
-
**Avoid:**
|
|
233
|
-
|
|
234
|
-
- Abstract descriptions without file references
|
|
235
|
-
- Explanations of "why" (that's for human docs)
|
|
236
|
-
- Stale information (validate regularly)
|
|
237
|
-
- Vague claims without evidence
|
|
238
|
-
|
|
239
|
-
## Example Documentation Sessions
|
|
240
|
-
|
|
241
|
-
### Example 1: Initial Session (No Map Exists)
|
|
242
|
-
|
|
243
|
-
**User Request:** "Document the codebase for other agents"
|
|
244
|
-
|
|
245
|
-
**Action:**
|
|
246
|
-
|
|
247
|
-
1. Use Glob to find major areas (features, stores, components)
|
|
248
|
-
2. Create initial DOCUMENTATION_MAP.md with all areas marked "not started"
|
|
249
|
-
3. Recommend starting with most critical area
|
|
250
|
-
4. Update map with initial structure
|
|
251
|
-
|
|
252
|
-
---
|
|
253
|
-
|
|
254
|
-
### Example 2: Documenting Stores
|
|
255
|
-
|
|
256
|
-
**User Request:** "Document the state management"
|
|
257
|
-
|
|
258
|
-
**Action:**
|
|
259
|
-
|
|
260
|
-
1. Glob to find all stores: `**/stores/*.ts` (kebab-case files)
|
|
261
|
-
2. Read each store file completely
|
|
262
|
-
3. Identify patterns (Zustand `create<State>()`? Context? Other?)
|
|
263
|
-
4. Map relationships between stores and consuming components
|
|
264
|
-
5. Create `store-map.md` using template
|
|
265
|
-
6. Update `DOCUMENTATION_MAP.md` marking stores as complete
|
|
266
|
-
|
|
267
|
-
---
|
|
268
|
-
|
|
269
|
-
### Example 3: Validating Documentation
|
|
270
|
-
|
|
271
|
-
**User Request:** "Validate the component patterns documentation"
|
|
272
|
-
|
|
273
|
-
**Action:**
|
|
274
|
-
|
|
275
|
-
1. Read `component-patterns.md`
|
|
276
|
-
2. Extract all file path claims
|
|
277
|
-
3. Verify each path exists
|
|
278
|
-
4. Use Glob/Grep to verify pattern claims
|
|
279
|
-
5. Check for new patterns since doc was created
|
|
280
|
-
6. Update doc with findings and report drift
|
|
281
|
-
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
## Example Output: Store/State Map
|
|
285
|
-
|
|
286
|
-
````markdown
|
|
287
|
-
# Store/State Map
|
|
288
|
-
|
|
289
|
-
**Last Updated:** 2025-01-24
|
|
290
|
-
|
|
291
|
-
## State Management Library
|
|
292
|
-
|
|
293
|
-
**Library:** Zustand
|
|
294
|
-
**Pattern:** `create<State>()` stores with selectors
|
|
295
|
-
|
|
296
|
-
## Stores
|
|
297
|
-
|
|
298
|
-
| Store | File Path | Purpose | Key Actions |
|
|
299
|
-
| ----------- | -------------------------------- | ----------------- | -------------------------------- |
|
|
300
|
-
| WizardStore | `src/cli/stores/wizard-store.ts` | Wizard flow state | `toggleSkill()`, `resetWizard()` |
|
|
301
|
-
|
|
302
|
-
## Store Relationships
|
|
303
|
-
|
|
304
|
-
- WizardStore consumed by wizard step components (`step-build.tsx`, `step-stack.tsx`, etc.)
|
|
305
|
-
- No root store pattern; each store is independent
|
|
306
|
-
|
|
307
|
-
## Usage Pattern
|
|
308
|
-
|
|
309
|
-
```typescript
|
|
310
|
-
import { useWizardStore } from "../../stores/wizard-store.js";
|
|
311
|
-
const domains = useWizardStore((s) => s.domains);
|
|
312
|
-
```
|
|
313
|
-
````
|
|
314
|
-
|
|
315
|
-
**Example files:** `src/cli/components/wizard/step-build.tsx`
|
|
316
|
-
|
|
317
|
-
````
|
|
318
|
-
|
|
319
|
-
---
|
|
320
|
-
|
|
321
|
-
## Example Output: Anti-Patterns
|
|
322
|
-
|
|
323
|
-
```markdown
|
|
324
|
-
# Anti-Patterns
|
|
325
|
-
|
|
326
|
-
**Last Updated:** 2025-01-24
|
|
327
|
-
|
|
328
|
-
## State Management
|
|
329
|
-
|
|
330
|
-
### Inline Test Data Construction
|
|
331
|
-
|
|
332
|
-
**What:** Constructing test configs, matrices, or skills inline instead of using factories
|
|
333
|
-
|
|
334
|
-
**Where:** [document actual locations found]
|
|
335
|
-
|
|
336
|
-
**Why wrong:** Violates project convention; bypasses shared test helpers; leads to stale/inconsistent test data
|
|
337
|
-
|
|
338
|
-
**Do instead:**
|
|
339
|
-
```typescript
|
|
340
|
-
import { createMockSkill, createMockMatrix } from "../__tests__/helpers.js";
|
|
341
|
-
const skill = createMockSkill("web-framework-react", "web/framework");
|
|
342
|
-
````
|
|
343
|
-
|
|
344
|
-
**Correct pattern:** `src/cli/lib/__tests__/helpers.ts` (factory functions)
|
|
345
|
-
|
|
346
|
-
````
|
|
347
|
-
|
|
348
|
-
---
|
|
349
|
-
|
|
350
|
-
## Example Output: Feature Map
|
|
351
|
-
|
|
352
|
-
```markdown
|
|
353
|
-
# Feature: Editor
|
|
354
|
-
|
|
355
|
-
**Last Updated:** 2025-01-24
|
|
356
|
-
|
|
357
|
-
## Overview
|
|
358
|
-
|
|
359
|
-
**Purpose:** Interactive wizard for configuring agent/skill stacks
|
|
360
|
-
**Entry Point:** `src/cli/commands/init.ts` (oclif command)
|
|
361
|
-
**Main Component:** `src/cli/components/wizard/wizard.tsx`
|
|
362
|
-
|
|
363
|
-
## File Structure
|
|
364
|
-
|
|
365
|
-
````
|
|
83
|
+
## What the Report Owes
|
|
366
84
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
├── step-build.tsx # Build configuration step
|
|
371
|
-
├── step-sources.tsx # Source selection step
|
|
372
|
-
├── step-confirm.tsx # Confirmation step
|
|
373
|
-
└── utils.ts # Wizard utility functions
|
|
85
|
+
**Name every search you ran, including the ones that returned nothing.** A document claiming nothing
|
|
86
|
+
else of a kind exists is only as good as the search behind it, and that search is invisible in the
|
|
87
|
+
document itself.
|
|
374
88
|
|
|
375
|
-
|
|
89
|
+
**Report a count as old value → new value, naming the symbol it counts.** "Re-derived the
|
|
90
|
+
counts" says nothing a reader can check; "`<CONSTANT>`: `<old>` → `<new>`" says which claim moved
|
|
91
|
+
and lets them verify it in one command.
|
|
376
92
|
|
|
377
|
-
|
|
93
|
+
**Say which sections you did not open.** A validation pass that covered four of a document's seven
|
|
94
|
+
sections is a useful pass and a dishonest date. The report is where the other three are named, and
|
|
95
|
+
`last_validated:` stays where it was until they are done.
|
|
378
96
|
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
| `wizard.tsx` | ~200 | Step orchestration |
|
|
382
|
-
| `step-build.tsx` | ~300 | Skill selection UI |
|
|
383
|
-
| `wizard-store.ts` | ~500 | Zustand state store |
|
|
384
|
-
```
|
|
97
|
+
**Cite a path and a symbol in the report as well as in the document.** The same rule applies to
|
|
98
|
+
both, for the same reason.
|