@proflandrigan/shards 1.1.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.
Files changed (397) hide show
  1. package/README.md +475 -0
  2. package/package.json +37 -0
  3. package/src/agents/academic.md +276 -0
  4. package/src/agents/ai-engineer.md +377 -0
  5. package/src/agents/analytics-engineer.md +364 -0
  6. package/src/agents/applied-ml-scientist.md +410 -0
  7. package/src/agents/backend-engineer.md +255 -0
  8. package/src/agents/bi-engineer.md +333 -0
  9. package/src/agents/data-analyst.md +343 -0
  10. package/src/agents/data-engineer.md +260 -0
  11. package/src/agents/data-modeller.md +386 -0
  12. package/src/agents/data-scientist.md +366 -0
  13. package/src/agents/deep-learning-engineer.md +389 -0
  14. package/src/agents/ml-engineer.md +424 -0
  15. package/src/agents/mlops-engineer.md +339 -0
  16. package/src/agents/researcher.md +187 -0
  17. package/src/agents/specific_instructions/academic/critical_review.md +263 -0
  18. package/src/agents/specific_instructions/academic/report.md +113 -0
  19. package/src/agents/specific_instructions/ai_engineer/advise.md +162 -0
  20. package/src/agents/specific_instructions/ai_engineer/bi_engineer_handoff.md +86 -0
  21. package/src/agents/specific_instructions/ai_engineer/experiment.md +471 -0
  22. package/src/agents/specific_instructions/ai_engineer/experiment_ui_mode.md +44 -0
  23. package/src/agents/specific_instructions/ai_engineer/phases/index.md +45 -0
  24. package/src/agents/specific_instructions/ai_engineer/phases/phase-1.md +55 -0
  25. package/src/agents/specific_instructions/ai_engineer/phases/phase-2.md +86 -0
  26. package/src/agents/specific_instructions/ai_engineer/phases/phase-3.md +96 -0
  27. package/src/agents/specific_instructions/ai_engineer/phases/phase-4.md +138 -0
  28. package/src/agents/specific_instructions/ai_engineer/phases/phase-5.md +157 -0
  29. package/src/agents/specific_instructions/ai_engineer/phases/phase-6.md +196 -0
  30. package/src/agents/specific_instructions/ai_engineer/phases/phase-7.md +313 -0
  31. package/src/agents/specific_instructions/ai_engineer/phases.md +1011 -0
  32. package/src/agents/specific_instructions/ai_engineer/prompt_lab.md +161 -0
  33. package/src/agents/specific_instructions/ai_engineer/prompt_lab_ui_mode.md +28 -0
  34. package/src/agents/specific_instructions/ai_engineer/research.md +393 -0
  35. package/src/agents/specific_instructions/ai_engineer/research_ui_mode.md +66 -0
  36. package/src/agents/specific_instructions/ai_engineer/review.md +159 -0
  37. package/src/agents/specific_instructions/ai_engineer/validation_checklist.md +182 -0
  38. package/src/agents/specific_instructions/analytics_engineer/advise.md +155 -0
  39. package/src/agents/specific_instructions/analytics_engineer/bi_engineer_handoff.md +91 -0
  40. package/src/agents/specific_instructions/analytics_engineer/data_analyst_handoff.md +84 -0
  41. package/src/agents/specific_instructions/analytics_engineer/deep_phases.md +818 -0
  42. package/src/agents/specific_instructions/analytics_engineer/phases_deep/index.md +24 -0
  43. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-1.md +77 -0
  44. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-2.md +106 -0
  45. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-3.md +93 -0
  46. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-4.md +79 -0
  47. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-5.md +61 -0
  48. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-6.md +45 -0
  49. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-7.md +235 -0
  50. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-8.md +221 -0
  51. package/src/agents/specific_instructions/analytics_engineer/phases_quick/index.md +19 -0
  52. package/src/agents/specific_instructions/analytics_engineer/phases_quick/phase-1.md +47 -0
  53. package/src/agents/specific_instructions/analytics_engineer/phases_quick/phase-2.md +78 -0
  54. package/src/agents/specific_instructions/analytics_engineer/quick_phases.md +112 -0
  55. package/src/agents/specific_instructions/analytics_engineer/review.md +167 -0
  56. package/src/agents/specific_instructions/analytics_engineer/service_mode.md +369 -0
  57. package/src/agents/specific_instructions/analytics_engineer/ui_mode.md +45 -0
  58. package/src/agents/specific_instructions/analytics_engineer/update.md +162 -0
  59. package/src/agents/specific_instructions/analytics_engineer/validation_checklist.md +121 -0
  60. package/src/agents/specific_instructions/applied_ml_scientist/advise.md +143 -0
  61. package/src/agents/specific_instructions/applied_ml_scientist/phases/index.md +21 -0
  62. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-1.md +51 -0
  63. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-2.md +66 -0
  64. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-3.md +113 -0
  65. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-4.md +104 -0
  66. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-5.md +156 -0
  67. package/src/agents/specific_instructions/applied_ml_scientist/phases.md +428 -0
  68. package/src/agents/specific_instructions/applied_ml_scientist/research.md +379 -0
  69. package/src/agents/specific_instructions/applied_ml_scientist/review.md +142 -0
  70. package/src/agents/specific_instructions/applied_ml_scientist/validation_checklist.md +136 -0
  71. package/src/agents/specific_instructions/backend_engineer/clean.md +149 -0
  72. package/src/agents/specific_instructions/backend_engineer/review.md +91 -0
  73. package/src/agents/specific_instructions/backend_engineer/review_checklist.md +54 -0
  74. package/src/agents/specific_instructions/backend_engineer/service_mode.md +67 -0
  75. package/src/agents/specific_instructions/bi_engineer/advise.md +137 -0
  76. package/src/agents/specific_instructions/bi_engineer/data_analyst_handoff.md +77 -0
  77. package/src/agents/specific_instructions/bi_engineer/incoming_handoff.md +45 -0
  78. package/src/agents/specific_instructions/bi_engineer/phases/index.md +20 -0
  79. package/src/agents/specific_instructions/bi_engineer/phases/phase-1.md +164 -0
  80. package/src/agents/specific_instructions/bi_engineer/phases/phase-2.md +92 -0
  81. package/src/agents/specific_instructions/bi_engineer/phases/phase-3.md +121 -0
  82. package/src/agents/specific_instructions/bi_engineer/phases/phase-4.md +106 -0
  83. package/src/agents/specific_instructions/bi_engineer/phases.md +451 -0
  84. package/src/agents/specific_instructions/bi_engineer/review.md +166 -0
  85. package/src/agents/specific_instructions/bi_engineer/update.md +147 -0
  86. package/src/agents/specific_instructions/bi_engineer/validation_checklist.md +124 -0
  87. package/src/agents/specific_instructions/data_analyst/advise.md +138 -0
  88. package/src/agents/specific_instructions/data_analyst/explain.md +221 -0
  89. package/src/agents/specific_instructions/data_analyst/incoming_handoff.md +40 -0
  90. package/src/agents/specific_instructions/data_analyst/phases/index.md +20 -0
  91. package/src/agents/specific_instructions/data_analyst/phases/phase-1.md +159 -0
  92. package/src/agents/specific_instructions/data_analyst/phases/phase-2.md +112 -0
  93. package/src/agents/specific_instructions/data_analyst/phases/phase-3.md +265 -0
  94. package/src/agents/specific_instructions/data_analyst/phases/phase-4.md +100 -0
  95. package/src/agents/specific_instructions/data_analyst/phases.md +501 -0
  96. package/src/agents/specific_instructions/data_analyst/review.md +138 -0
  97. package/src/agents/specific_instructions/data_analyst/ui_mode.md +26 -0
  98. package/src/agents/specific_instructions/data_analyst/update.md +144 -0
  99. package/src/agents/specific_instructions/data_analyst/validation_checklist.md +95 -0
  100. package/src/agents/specific_instructions/data_engineer/advise.md +137 -0
  101. package/src/agents/specific_instructions/data_engineer/phases.md +466 -0
  102. package/src/agents/specific_instructions/data_engineer/phases_deep/index.md +23 -0
  103. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-1.md +49 -0
  104. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-2.md +93 -0
  105. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-3.md +55 -0
  106. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-4.md +48 -0
  107. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-5.md +40 -0
  108. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-6.md +102 -0
  109. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-7.md +87 -0
  110. package/src/agents/specific_instructions/data_engineer/phases_quick/index.md +19 -0
  111. package/src/agents/specific_instructions/data_engineer/phases_quick/phase-1.md +45 -0
  112. package/src/agents/specific_instructions/data_engineer/phases_quick/phase-2.md +54 -0
  113. package/src/agents/specific_instructions/data_engineer/review.md +135 -0
  114. package/src/agents/specific_instructions/data_engineer/validation_checklist.md +136 -0
  115. package/src/agents/specific_instructions/data_modeller/advise.md +137 -0
  116. package/src/agents/specific_instructions/data_modeller/phases.md +581 -0
  117. package/src/agents/specific_instructions/data_modeller/phases_deep/index.md +23 -0
  118. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-1.md +52 -0
  119. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-2.md +113 -0
  120. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-3.md +47 -0
  121. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-4.md +51 -0
  122. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-5.md +45 -0
  123. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-6.md +105 -0
  124. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-7.md +136 -0
  125. package/src/agents/specific_instructions/data_modeller/phases_quick/index.md +19 -0
  126. package/src/agents/specific_instructions/data_modeller/phases_quick/phase-1.md +47 -0
  127. package/src/agents/specific_instructions/data_modeller/phases_quick/phase-2.md +65 -0
  128. package/src/agents/specific_instructions/data_modeller/review.md +141 -0
  129. package/src/agents/specific_instructions/data_modeller/service_mode.md +218 -0
  130. package/src/agents/specific_instructions/data_modeller/validation_checklist.md +125 -0
  131. package/src/agents/specific_instructions/data_scientist/advise.md +158 -0
  132. package/src/agents/specific_instructions/data_scientist/bi_engineer_handoff.md +63 -0
  133. package/src/agents/specific_instructions/data_scientist/experiment.md +482 -0
  134. package/src/agents/specific_instructions/data_scientist/experiment_ui_mode.md +44 -0
  135. package/src/agents/specific_instructions/data_scientist/explain.md +247 -0
  136. package/src/agents/specific_instructions/data_scientist/greenfield_data.md +35 -0
  137. package/src/agents/specific_instructions/data_scientist/ml_engineer_handoff.md +52 -0
  138. package/src/agents/specific_instructions/data_scientist/notebook_walkthrough.md +76 -0
  139. package/src/agents/specific_instructions/data_scientist/phases/index.md +24 -0
  140. package/src/agents/specific_instructions/data_scientist/phases/phase-1.md +45 -0
  141. package/src/agents/specific_instructions/data_scientist/phases/phase-2.md +67 -0
  142. package/src/agents/specific_instructions/data_scientist/phases/phase-3.md +89 -0
  143. package/src/agents/specific_instructions/data_scientist/phases/phase-4.md +143 -0
  144. package/src/agents/specific_instructions/data_scientist/phases/phase-5.md +71 -0
  145. package/src/agents/specific_instructions/data_scientist/phases/phase-6.md +239 -0
  146. package/src/agents/specific_instructions/data_scientist/phases/phase-7.md +207 -0
  147. package/src/agents/specific_instructions/data_scientist/phases.md +651 -0
  148. package/src/agents/specific_instructions/data_scientist/research.md +345 -0
  149. package/src/agents/specific_instructions/data_scientist/research_ui_mode.md +52 -0
  150. package/src/agents/specific_instructions/data_scientist/review.md +136 -0
  151. package/src/agents/specific_instructions/data_scientist/service_mode.md +247 -0
  152. package/src/agents/specific_instructions/data_scientist/validation_checklist.md +183 -0
  153. package/src/agents/specific_instructions/deep_learning_engineer/advise.md +145 -0
  154. package/src/agents/specific_instructions/deep_learning_engineer/phases/index.md +21 -0
  155. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-1.md +74 -0
  156. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-2.md +98 -0
  157. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-3.md +76 -0
  158. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-4.md +128 -0
  159. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-5.md +292 -0
  160. package/src/agents/specific_instructions/deep_learning_engineer/phases.md +567 -0
  161. package/src/agents/specific_instructions/deep_learning_engineer/research.md +389 -0
  162. package/src/agents/specific_instructions/deep_learning_engineer/review.md +155 -0
  163. package/src/agents/specific_instructions/deep_learning_engineer/validation_checklist.md +147 -0
  164. package/src/agents/specific_instructions/ml_engineer/advise.md +174 -0
  165. package/src/agents/specific_instructions/ml_engineer/bi_engineer_handoff.md +71 -0
  166. package/src/agents/specific_instructions/ml_engineer/experiment.md +474 -0
  167. package/src/agents/specific_instructions/ml_engineer/experiment_ui_mode.md +44 -0
  168. package/src/agents/specific_instructions/ml_engineer/notebook_walkthrough.md +75 -0
  169. package/src/agents/specific_instructions/ml_engineer/phases/index.md +25 -0
  170. package/src/agents/specific_instructions/ml_engineer/phases/phase-1.md +49 -0
  171. package/src/agents/specific_instructions/ml_engineer/phases/phase-2.md +75 -0
  172. package/src/agents/specific_instructions/ml_engineer/phases/phase-3.md +124 -0
  173. package/src/agents/specific_instructions/ml_engineer/phases/phase-4.md +279 -0
  174. package/src/agents/specific_instructions/ml_engineer/phases/phase-5.md +160 -0
  175. package/src/agents/specific_instructions/ml_engineer/phases/phase-6-5.md +170 -0
  176. package/src/agents/specific_instructions/ml_engineer/phases/phase-6.md +295 -0
  177. package/src/agents/specific_instructions/ml_engineer/phases/phase-7.md +337 -0
  178. package/src/agents/specific_instructions/ml_engineer/phases.md +1068 -0
  179. package/src/agents/specific_instructions/ml_engineer/research.md +437 -0
  180. package/src/agents/specific_instructions/ml_engineer/research_ui_mode.md +71 -0
  181. package/src/agents/specific_instructions/ml_engineer/review.md +187 -0
  182. package/src/agents/specific_instructions/ml_engineer/service_mode.md +273 -0
  183. package/src/agents/specific_instructions/ml_engineer/validation_checklist.md +185 -0
  184. package/src/agents/specific_instructions/mlops_engineer/advise.md +139 -0
  185. package/src/agents/specific_instructions/mlops_engineer/phases/index.md +23 -0
  186. package/src/agents/specific_instructions/mlops_engineer/phases/phase-1.md +52 -0
  187. package/src/agents/specific_instructions/mlops_engineer/phases/phase-2.md +86 -0
  188. package/src/agents/specific_instructions/mlops_engineer/phases/phase-3.md +105 -0
  189. package/src/agents/specific_instructions/mlops_engineer/phases/phase-4.md +128 -0
  190. package/src/agents/specific_instructions/mlops_engineer/phases/phase-5.md +106 -0
  191. package/src/agents/specific_instructions/mlops_engineer/phases/phase-6.md +128 -0
  192. package/src/agents/specific_instructions/mlops_engineer/phases/phase-7.md +144 -0
  193. package/src/agents/specific_instructions/mlops_engineer/phases.md +671 -0
  194. package/src/agents/specific_instructions/mlops_engineer/review.md +164 -0
  195. package/src/agents/specific_instructions/mlops_engineer/service_mode.md +81 -0
  196. package/src/agents/specific_instructions/mlops_engineer/validation_checklist.md +151 -0
  197. package/src/agents/specific_instructions/researcher/critical_review.md +292 -0
  198. package/src/agents/specific_instructions/researcher/review_checklist.md +67 -0
  199. package/src/agents/specific_instructions/researcher/service_mode.md +224 -0
  200. package/src/agents/specific_instructions/shared/auto_verify_mode.md +141 -0
  201. package/src/agents/specific_instructions/shared/autonomous_research.md +1289 -0
  202. package/src/agents/specific_instructions/shared/behavioral_rules.md +36 -0
  203. package/src/agents/specific_instructions/shared/diverge_protocol.md +387 -0
  204. package/src/agents/specific_instructions/shared/engineering_guidelines.md +136 -0
  205. package/src/agents/specific_instructions/shared/experiment_versioning.md +184 -0
  206. package/src/agents/specific_instructions/shared/goal_mode.md +187 -0
  207. package/src/agents/specific_instructions/shared/incremental_testing.md +139 -0
  208. package/src/agents/specific_instructions/shared/intent_discovery.md +223 -0
  209. package/src/agents/specific_instructions/shared/join_path_protocol.md +168 -0
  210. package/src/agents/specific_instructions/shared/knowledge_checkpoint.md +83 -0
  211. package/src/agents/specific_instructions/shared/knowledge_harvest.md +220 -0
  212. package/src/agents/specific_instructions/shared/knowledge_retrieval.md +100 -0
  213. package/src/agents/specific_instructions/shared/notebook_walkthrough_protocol.md +367 -0
  214. package/src/agents/specific_instructions/shared/reviewer_verdict_protocol.md +74 -0
  215. package/src/agents/specific_instructions/shared/swarm_protocol.md +97 -0
  216. package/src/agents/specific_instructions/shared/validation_protocol.md +139 -0
  217. package/src/agents/specific_instructions/syn/arbiter.md +140 -0
  218. package/src/agents/specific_instructions/syn/brainstorm.md +550 -0
  219. package/src/agents/specific_instructions/syn/code_review.md +232 -0
  220. package/src/agents/specific_instructions/syn/diff.md +239 -0
  221. package/src/agents/specific_instructions/syn/final_review.md +65 -0
  222. package/src/agents/specific_instructions/syn/fixer.md +240 -0
  223. package/src/agents/specific_instructions/syn/free_form.md +130 -0
  224. package/src/agents/specific_instructions/syn/knowledge.md +468 -0
  225. package/src/agents/specific_instructions/syn/notebook_walkthrough.md +78 -0
  226. package/src/agents/specific_instructions/syn/panel_review.md +634 -0
  227. package/src/agents/specific_instructions/syn/pm.md +453 -0
  228. package/src/agents/specific_instructions/syn/pr_review.md +255 -0
  229. package/src/agents/specific_instructions/syn/slides.md +417 -0
  230. package/src/agents/syn.md +729 -0
  231. package/src/commands/academic.md +41 -0
  232. package/src/commands/ai-engineer.md +45 -0
  233. package/src/commands/analytics-engineer.md +48 -0
  234. package/src/commands/applied-ml-scientist.md +45 -0
  235. package/src/commands/backend-engineer.md +35 -0
  236. package/src/commands/bi-engineer.md +40 -0
  237. package/src/commands/brainstorm.md +24 -0
  238. package/src/commands/data-analyst.md +38 -0
  239. package/src/commands/data-engineer.md +37 -0
  240. package/src/commands/data-modeller.md +38 -0
  241. package/src/commands/data-scientist.md +38 -0
  242. package/src/commands/deep-learning-engineer.md +47 -0
  243. package/src/commands/end.md +49 -0
  244. package/src/commands/knowledge.md +24 -0
  245. package/src/commands/ml-engineer.md +42 -0
  246. package/src/commands/mlops-engineer.md +47 -0
  247. package/src/commands/notebook-walkthrough.md +58 -0
  248. package/src/commands/researcher.md +40 -0
  249. package/src/commands/resume.md +57 -0
  250. package/src/commands/review-pr.md +26 -0
  251. package/src/commands/shards-guide.md +41 -0
  252. package/src/commands/shards-ui.md +32 -0
  253. package/src/commands/shards.md +41 -0
  254. package/src/docs/01-getting-started/concepts.md +109 -0
  255. package/src/docs/01-getting-started/first-session.md +79 -0
  256. package/src/docs/01-getting-started/install.md +61 -0
  257. package/src/docs/02-agents/academic.md +71 -0
  258. package/src/docs/02-agents/ai-engineer.md +78 -0
  259. package/src/docs/02-agents/analytics-engineer.md +58 -0
  260. package/src/docs/02-agents/applied-ml-scientist.md +59 -0
  261. package/src/docs/02-agents/backend-engineer.md +58 -0
  262. package/src/docs/02-agents/bi-engineer.md +65 -0
  263. package/src/docs/02-agents/data-analyst.md +67 -0
  264. package/src/docs/02-agents/data-engineer.md +57 -0
  265. package/src/docs/02-agents/data-modeller.md +51 -0
  266. package/src/docs/02-agents/data-scientist.md +78 -0
  267. package/src/docs/02-agents/deep-learning-engineer.md +64 -0
  268. package/src/docs/02-agents/ml-engineer.md +80 -0
  269. package/src/docs/02-agents/mlops-engineer.md +59 -0
  270. package/src/docs/02-agents/overview.md +62 -0
  271. package/src/docs/02-agents/researcher.md +73 -0
  272. package/src/docs/02-agents/syn.md +88 -0
  273. package/src/docs/03-protocols/auto-verify.md +82 -0
  274. package/src/docs/03-protocols/autonomous-research.md +59 -0
  275. package/src/docs/03-protocols/behavioral-rules.md +35 -0
  276. package/src/docs/03-protocols/diverge.md +50 -0
  277. package/src/docs/03-protocols/engineering-guidelines.md +56 -0
  278. package/src/docs/03-protocols/experiment-versioning.md +38 -0
  279. package/src/docs/03-protocols/gate-pattern.md +65 -0
  280. package/src/docs/03-protocols/incremental-testing.md +68 -0
  281. package/src/docs/03-protocols/join-path.md +46 -0
  282. package/src/docs/03-protocols/knowledge-ledger.md +70 -0
  283. package/src/docs/03-protocols/reviewer-verdicts.md +39 -0
  284. package/src/docs/03-protocols/swarm.md +40 -0
  285. package/src/docs/03-protocols/validation.md +174 -0
  286. package/src/docs/04-ui/activity-bar.md +70 -0
  287. package/src/docs/04-ui/chat-pane.md +80 -0
  288. package/src/docs/04-ui/code-intel.md +62 -0
  289. package/src/docs/04-ui/file-editing.md +61 -0
  290. package/src/docs/04-ui/git.md +54 -0
  291. package/src/docs/04-ui/keybindings.md +79 -0
  292. package/src/docs/04-ui/knowledge-map.md +76 -0
  293. package/src/docs/04-ui/overview.md +93 -0
  294. package/src/docs/04-ui/panels.md +49 -0
  295. package/src/docs/04-ui/pinboard-selection.md +66 -0
  296. package/src/docs/04-ui/quick-open-palette.md +56 -0
  297. package/src/docs/04-ui/sessions.md +81 -0
  298. package/src/docs/04-ui/settings-permissions.md +56 -0
  299. package/src/docs/05-commands/reference.md +59 -0
  300. package/src/docs/06-outputs/directory-map.md +116 -0
  301. package/src/docs/07-workflows/ai-eval-first.md +57 -0
  302. package/src/docs/07-workflows/deep-study-to-production.md +76 -0
  303. package/src/docs/07-workflows/diverge-exploration.md +77 -0
  304. package/src/docs/07-workflows/quick-analysis.md +45 -0
  305. package/src/docs/08-integrations/claude-code-auto-mode.md +191 -0
  306. package/src/docs/08-integrations/google-slides.md +175 -0
  307. package/src/docs/README.md +30 -0
  308. package/src/docs/manifest.json +108 -0
  309. package/src/templates/analysis-template.md +20 -0
  310. package/src/templates/branch-report.md +46 -0
  311. package/src/templates/diff-report.md +88 -0
  312. package/src/templates/knowledge-index.md +7 -0
  313. package/src/templates/model-card-schema.json +186 -0
  314. package/src/templates/model-card-schema.md +88 -0
  315. package/src/templates/model-card.md +124 -0
  316. package/src/templates/project-plan.md +47 -0
  317. package/src/templates/project-specs.md +81 -0
  318. package/src/templates/report-template.md +43 -0
  319. package/src/templates/study-template.md +25 -0
  320. package/src/ui/cc-readonly.js +181 -0
  321. package/src/ui/chat-session.js +466 -0
  322. package/src/ui/css/base.css +136 -0
  323. package/src/ui/css/brainstorm.css +525 -0
  324. package/src/ui/css/chat.css +1405 -0
  325. package/src/ui/css/editor.css +546 -0
  326. package/src/ui/css/eval-dashboard.css +157 -0
  327. package/src/ui/css/experiment.css +237 -0
  328. package/src/ui/css/guide.css +186 -0
  329. package/src/ui/css/knowledge-map.css +383 -0
  330. package/src/ui/css/layout.css +431 -0
  331. package/src/ui/css/model-card.css +161 -0
  332. package/src/ui/css/notebook-walkthrough.css +271 -0
  333. package/src/ui/css/pr-review.css +403 -0
  334. package/src/ui/css/prompt-lab.css +325 -0
  335. package/src/ui/css/sessions.css +258 -0
  336. package/src/ui/css/sidebar.css +661 -0
  337. package/src/ui/css/terminal.css +113 -0
  338. package/src/ui/css/theme-light.css +542 -0
  339. package/src/ui/index.html +389 -0
  340. package/src/ui/js/agents.js +32 -0
  341. package/src/ui/js/bookmarks.js +230 -0
  342. package/src/ui/js/chat.js +1776 -0
  343. package/src/ui/js/code-intel.js +328 -0
  344. package/src/ui/js/command-palette.js +142 -0
  345. package/src/ui/js/events.js +591 -0
  346. package/src/ui/js/explorer.js +317 -0
  347. package/src/ui/js/file-view.js +477 -0
  348. package/src/ui/js/git.js +536 -0
  349. package/src/ui/js/guide.js +198 -0
  350. package/src/ui/js/hud.js +75 -0
  351. package/src/ui/js/init.js +351 -0
  352. package/src/ui/js/knowledge-map.js +906 -0
  353. package/src/ui/js/markdown.js +114 -0
  354. package/src/ui/js/monaco.js +164 -0
  355. package/src/ui/js/notebook-walkthrough.js +272 -0
  356. package/src/ui/js/notebook.js +448 -0
  357. package/src/ui/js/panels.js +2681 -0
  358. package/src/ui/js/pinboard.js +186 -0
  359. package/src/ui/js/quick-open.js +164 -0
  360. package/src/ui/js/selection-context.js +131 -0
  361. package/src/ui/js/sessions.js +256 -0
  362. package/src/ui/js/settings.js +476 -0
  363. package/src/ui/js/split-view.js +82 -0
  364. package/src/ui/js/state.js +343 -0
  365. package/src/ui/js/table.js +161 -0
  366. package/src/ui/js/tabs.js +284 -0
  367. package/src/ui/js/tabular.js +125 -0
  368. package/src/ui/js/terminal.js +354 -0
  369. package/src/ui/js/timeline.js +137 -0
  370. package/src/ui/js/utils.js +293 -0
  371. package/src/ui/notebook-kernel.py +790 -0
  372. package/src/ui/open-browser.js +55 -0
  373. package/src/ui/permission-pattern.js +42 -0
  374. package/src/ui/relay.js +513 -0
  375. package/src/ui/server.js +3072 -0
  376. package/src/ui/session-index.js +225 -0
  377. package/src/ui/shards_icon.png +0 -0
  378. package/src/ui/spawn-server.js +41 -0
  379. package/src/ui/symbol-index.js +813 -0
  380. package/src/ui/ui-push.js +177 -0
  381. package/tools/gate-hook/VALIDATION_SPEC.md +273 -0
  382. package/tools/gate-hook/__tests__/auto-verify.test.js +343 -0
  383. package/tools/gate-hook/auto-allowlist.js +179 -0
  384. package/tools/gate-hook/auto-state.js +68 -0
  385. package/tools/gate-hook/classify.js +21 -0
  386. package/tools/gate-hook/log.js +57 -0
  387. package/tools/gate-hook/parser.js +205 -0
  388. package/tools/gate-hook/sql-guard.js +230 -0
  389. package/tools/gate-hook/state.js +170 -0
  390. package/tools/gate-hook/sweep.js +139 -0
  391. package/tools/gate-hook/transcript.js +45 -0
  392. package/tools/gate-hook/validation.js +321 -0
  393. package/tools/gate-hook.js +475 -0
  394. package/tools/install.js +914 -0
  395. package/tools/shards-gates.js +311 -0
  396. package/tools/shards-sessions.js +261 -0
  397. package/tools/shards-ui.js +377 -0
@@ -0,0 +1,337 @@
1
+ > **Previous:** phase-6-5.md confirmed (or phase-6.md confirmed if 6.5 was skipped)
2
+ > **Next:** This is the final phase — follow the Syn sign-off instructions in this phase to close the project.
3
+
4
+ ---
5
+
6
+ ## Phase 7 — Review and Handoff
7
+
8
+ **Code review (Python scripts and notebooks):**
9
+
10
+ Tell the user: "Before Syn signs off, we're running code review on the Python
11
+ artifacts. Scripts go to the Backend Engineer; notebooks go to the Data
12
+ Scientist for a domain-aware read. Code quality is not optional."
13
+
14
+ Glob the project directory (`models/<project_name>/`) for `.py` files and,
15
+ separately, for `.ipynb` files.
16
+
17
+ **Python scripts → Backend Engineer** (only if any `.py` files were found):
18
+
19
+ ```
20
+ Task(
21
+ subagent_type="backend-engineer",
22
+ description="Python code review for [project_name]",
23
+ prompt="You are in SERVICE MODE. Review the Python scripts in the project at
24
+ models/[project_name]/. Read project-specs.md first for context.
25
+ Files to review: [list of .py files found]"
26
+ )
27
+ ```
28
+
29
+ **Notebooks → Data Scientist** (only if any `.ipynb` files were found). Cross-
30
+ shard review — the Data Scientist catches modelling bugs, data leakage, and
31
+ statistical issues that the author of the notebook is likely blind to:
32
+
33
+ ```
34
+ Task(
35
+ subagent_type="data-scientist",
36
+ description="Notebook code review for [project_name]",
37
+ prompt="SERVICE MODE — NOTEBOOK CODE REVIEW. Review the Jupyter notebooks in
38
+ the project at models/[project_name]/. Read project-specs.md first for
39
+ context.
40
+ Files to review: [list of .ipynb files found]
41
+ Your job here is review only — do not apply any fixes."
42
+ )
43
+ ```
44
+
45
+ If both buckets are non-empty, fire both Task calls in parallel. If neither
46
+ bucket has files, report "No Python code artifacts — skipping code review."
47
+
48
+ Append both reviews to project-specs.md under a combined `Code Review` heading.
49
+
50
+ **After appending the reviews, branch on the worst verdict across both:**
51
+
52
+ - **Clean or Minor Issues** → proceed directly to Syn review.
53
+ - **Refactor Required** → tell the user: "Reviewer(s) flagged structural
54
+ issues. Fixing before Syn review." Address every listed issue in the
55
+ project files (the notebook reviewer may also be re-invoked in apply-fixes
56
+ mode — see Step 5c of Syn's code_review mode for the call pattern). Update
57
+ project-specs.md. Re-gate: "Reviewer issues resolved: [summary]. Confirm
58
+ to proceed to Syn?" Then proceed to Syn.
59
+ - **Blocked** → tell the user: "Reviewer has blocked this. Fixing critical
60
+ issues before continuing." Address every critical issue. Update
61
+ project-specs.md. Resubmit to the same reviewer(s) once. If the second
62
+ verdict is Clean/Minor Issues/Refactor Required, proceed to Syn. If still
63
+ Blocked, surface to user: "Reviewer has blocked this twice. [Verbatim
64
+ second verdict.] How would you like to proceed? (a) Override and proceed
65
+ to Syn — I'll document the disagreement. (b) Continue fixing — tell me
66
+ what to change. (c) Stop the project."
67
+
68
+ ---
69
+
70
+ **Applied ML Scientist final methodology sign-off:**
71
+
72
+ Tell the user: "Before Syn signs off, I'm asking the Applied ML Scientist for a
73
+ final methodology pass on the completed project. Design review happened at
74
+ Phase 4, results review at Phase 6 — this is the closing sign-off on the ML
75
+ science as a whole. Skip if Phase 4 and Phase 6 AMS reviews were both skipped
76
+ per standard-tabular criteria."
77
+
78
+ If Phase 4 or Phase 6 consulted AMS, always run this final sign-off. If both
79
+ skipped AMS, skip this too and state: "Skipping AMS final sign-off — standard
80
+ methodology, no prior AMS consultations."
81
+
82
+ ```
83
+ Task(
84
+ subagent_type="applied-ml-scientist",
85
+ description="Final methodology sign-off for <project_name>",
86
+ prompt="I am the ML Engineer shard closing out <project_name>. You reviewed the
87
+ design at Phase 4 and the training results at Phase 6. This is the final
88
+ methodology sign-off before Syn's holistic review.
89
+
90
+ Project specs: <path to project-specs.md>
91
+ Model card: <path to model-card.json>
92
+ Report: <path to report.md>
93
+ Eval results: <path to eval-results.json>
94
+
95
+ Please review the project as a whole and answer:
96
+ 1. Is the methodology — from problem framing through evaluation — internally
97
+ consistent? Are there drifts between what was designed, what was built, and
98
+ what's being reported?
99
+ 2. Does the model card accurately represent what the model does, its
100
+ limitations, and its known failure modes?
101
+ 3. Are there methodology-level risks that should be flagged to stakeholders
102
+ before deployment (not infrastructure — those go to MLOps)?
103
+ 4. Final verdict: does the science hold up?
104
+
105
+ Return a structured ML Science Review per your service-mode format, scoped to
106
+ the final sign-off (not a re-review of Phase 4/6 material)."
107
+ )
108
+ ```
109
+
110
+ Apply the Reviewer Verdict Protocol. Append the review to project-specs.md.
111
+
112
+ ---
113
+
114
+ **MLOps Engineer consultation (serving infrastructure and deployment pipeline):**
115
+
116
+ Tell the user: "Before Syn signs off, I'm asking the MLOps Engineer to validate
117
+ the serving infrastructure and deployment pipeline. They care about what it takes
118
+ to actually operate this model."
119
+
120
+ ```
121
+ Task(
122
+ subagent_type="mlops-engineer",
123
+ description="Serving infrastructure review for ML project: [project_name]",
124
+ prompt="I am the ML Engineer shard. I have designed a production ML system for
125
+ project [project_name] and need an infrastructure and operationalization review.
126
+
127
+ Project directory: models/<project_name>/
128
+ Specs: models/<project_name>/project-specs.md
129
+
130
+ Summary:
131
+ - Model type: <final model type from Phase 4>
132
+ - Inference requirements: <latency, throughput from Phase 6>
133
+ - Serving format: <from Phase 6 production considerations>
134
+ - Feature pipeline: <from Phase 6>
135
+ - Retraining trigger: <from Phase 6>
136
+
137
+ Please review:
138
+ 1. Is the proposed serving infrastructure appropriate for the latency and
139
+ throughput requirements?
140
+ 2. Are there gaps in the CI/CD and model registry design?
141
+ 3. Is the monitoring and alerting plan sufficient for production operation?
142
+ 4. Are the retraining triggers and automation plan feasible?
143
+ 5. What would you need from me to stand up this deployment?
144
+
145
+ Please read project-specs.md for full context."
146
+ )
147
+ ```
148
+
149
+ Append MLOps Engineer's review to specs. Present to user.
150
+
151
+ **Before finalizing**, invoke Syn for final review:
152
+
153
+ Tell the user: "I'm asking Syn to review the full project specs before we ship this..."
154
+
155
+ ```
156
+ Task(
157
+ subagent_type="syn",
158
+ description="Final review of ML engineering project",
159
+ prompt="I am the ML Engineer shard. I've completed all phases for project
160
+ [project_name]. Please review the project-specs.md at [file_path] and provide
161
+ your final review verdict. This is an ML engineering project — check for:
162
+ business alignment, methodology soundness, infrastructure readiness,
163
+ monitoring plan, and rollback strategy."
164
+ )
165
+ ```
166
+
167
+ Append Syn's review to specs. Present to user.
168
+
169
+ **If Syn returns NEEDS REVISION:**
170
+ 1. Address the specific issues Syn flagged.
171
+ 2. Update project-specs.md with the changes.
172
+ 3. Re-gate with the user: "Syn flagged [N] issues. Here's what I changed: [summary]. Confirm to resubmit?"
173
+ 4. Resubmit to Syn ONCE more.
174
+
175
+ **If Syn returns NEEDS REVISION a second time:**
176
+ Do not resubmit again. Instead, present to the user:
177
+ "Syn has flagged concerns twice. Here is the current conflict:
178
+ - Syn's concern: [verbatim from Syn's second review]
179
+ - Current state of specs: [summary of what's documented]
180
+ How would you like to proceed? (a) Override Syn and execute as-is — I'll document the disagreement. (b) Continue revising — tell me what to change. (c) Stop the project."
181
+
182
+ Document the outcome in specs:
183
+ **Syn review resolution:** Approved | Approved on resubmit | User override — <rationale> | Project stopped
184
+
185
+ If Syn's review includes a "Code Review" section with `Code artifacts found: Yes`:
186
+ - Tell the user: "Syn spotted [N] code file(s) it can review. Want a code pass? (y/n)"
187
+ - If yes, invoke:
188
+
189
+ ```
190
+ Task(
191
+ subagent_type="syn",
192
+ description="Code review and fix for ML engineering project",
193
+ prompt="CODE REVIEW MODE. I am the ML Engineer shard. Project: [project_name].
194
+ Directory: [project_dir]. Please review and fix the code artifacts produced
195
+ in this project. The project-specs.md is at [file_path] for context."
196
+ )
197
+ ```
198
+
199
+ Append Syn's code review summary to the specs. Present findings to user.
200
+
201
+ Then:
202
+
203
+ 1. **Generate Model Card** — Assemble a structured model card for stakeholder
204
+ sharing. Read `project-specs.md` to extract: ML system type and description
205
+ (Phase 1), data sources (Phase 3), model design and evaluation strategy
206
+ (Phase 4), feature engineering (Phase 5), build results (Phase 6), review
207
+ verdicts (Phase 7). Read `eval-results.json` for quantitative metrics.
208
+
209
+ Consult the Academic shard for ethical considerations:
210
+
211
+ ```
212
+ Task(
213
+ subagent_type="academic",
214
+ description="Ethical considerations for model card",
215
+ prompt="I am the ML Engineer shard generating a model card for project
216
+ [project_name]. The model is: [1-2 sentence description from Phase 1].
217
+ End users of the model's output: [from Phase 1]. Model type: [from Phase 4].
218
+ Training data: [summary from Phase 3].
219
+ Please provide 2-4 ethical considerations and recommended mitigations
220
+ for the model card's Ethical Considerations section. Be specific to
221
+ this model's use case. Keep it concise — bullet points preferred."
222
+ )
223
+ ```
224
+
225
+ If the Academic shard is unavailable, populate ethical considerations based
226
+ on the fairness and bias considerations from the model design phase and note
227
+ that a formal ethics review was not completed.
228
+
229
+ Write `model-card.json` to:
230
+ - Greenfield: `models/<name>/model-card.json`
231
+ - Iteration: `<existing_service_dir>/model-card.json`
232
+
233
+ The JSON must conform to the schema defined in
234
+ `templates/model-card-schema.json` (JSON Schema, draft 2020-12).
235
+ See `templates/model-card-schema.md` for an annotated example and
236
+ field notes.
237
+
238
+ ML-engineer-specific overrides:
239
+ - `generatedBy`: `"ml-engineer"`.
240
+ - `evalSummary.cost.per1kTokens`: `null` unless the model is an LLM.
241
+ - `modelDetails.type`: e.g. `"LightGBM classifier"`, `"XGBoost regressor"`,
242
+ `"scikit-learn pipeline"`.
243
+
244
+ If the Shards UI is active (`.shards/ui.port` file exists), push the model
245
+ card panel:
246
+ ```bash
247
+ node .shards/ui/ui-push.js model-card \
248
+ --title "Model Card: <project_name>" \
249
+ --agent "ml-engineer" \
250
+ --panel-id "mc-<project_name>" \
251
+ --source "<path_to>/model-card.json"
252
+ ```
253
+
254
+ 2. **Write a report** to:
255
+ - Greenfield: `models/<name>/report.md`
256
+ - Iteration: `<existing_service_dir>/report.md`
257
+ - Executive summary: business problem, solution, key results
258
+ - Model performance: baseline vs. final, with business interpretation
259
+ - Infrastructure plan: serving, monitoring, rollback
260
+ - Deployment checklist: what needs to happen to go live
261
+ - Risks and mitigations
262
+
263
+ 2. Summarize top findings in 3-5 bullet points
264
+ 3. Present deployment checklist
265
+ 4. Flag risks, open questions, and dependencies
266
+ 5. Confirm the deliverable meets the definition of done
267
+
268
+ **MLOps handoff:** If the user wants to proceed to deployment, tell them:
269
+ "To deploy and operate this model, run `/mlops-engineer` and reference
270
+ `models/<project_name>/` as the model handoff directory."
271
+
272
+ **BI monitoring dashboard handoff:** See `.claude/agents/specific_instructions/ml_engineer/bi_engineer_handoff.md` for the full handoff instructions (Phase 7 section).
273
+
274
+ **Knowledge harvest.** Before closing, extract reusable knowledge from this project.
275
+ Read `.claude/agents/specific_instructions/shared/knowledge_harvest.md` and follow
276
+ the protocol. Present candidates to the user for confirmation before writing.
277
+
278
+ ### Document Phase 7
279
+
280
+ ```markdown
281
+ ---
282
+
283
+ ## Phase 7: Review and Handoff (ML Engineer)
284
+ - **Backend Engineer Review (.py scripts):** <summary or N/A — list files reviewed, overall verdict>
285
+ - **Data Scientist Review (.ipynb notebooks):** <summary or N/A — list notebooks reviewed, overall verdict>
286
+ - **Applied ML Scientist final sign-off:** <summary if consulted> | Skipped — Phase 4 and Phase 6 AMS reviews both skipped per standard-tabular criteria
287
+ - Verdict: Sound | Consider Alternatives | Revise
288
+ - Tier: Proceed | Proceed with caveats | Halt
289
+ - Methodology consistency notes: <drifts surfaced or "none">
290
+ - Model card accuracy notes: <accurate | concerns — description>
291
+ - Stakeholder risks flagged: <list or "none">
292
+ - Reviewer resolution: Approved | Approved on resubmit | User override — <rationale> | Project stopped
293
+ - **MLOps Engineer Review:**
294
+ - Verdict: Approved | Concerns | Redesign needed
295
+ - Notes: <summary of infrastructure feedback>
296
+ - **Syn Review:** <included above>
297
+ - **Syn review resolution:** Approved | Approved on resubmit | User override — <rationale> | Project stopped
298
+ - **Model card:** <file path to model-card.json>
299
+ - **Report location:** <file path>
300
+ - **Model summary:**
301
+ - Type: <final model type>
302
+ - Key metric: <metric> = <value> (business interpretation)
303
+ - Model size: <X>MB | Inference: <X>ms
304
+ - **Deployment checklist:**
305
+ - [ ] Training pipeline deployed and tested
306
+ - [ ] Model registered in model registry
307
+ - [ ] Serving endpoint deployed (shadow mode first)
308
+ - [ ] Monitoring dashboards configured
309
+ - [ ] Alerting thresholds set
310
+ - [ ] Rollback procedure documented and tested
311
+ - [ ] A/B test or shadow mode plan approved
312
+ - [ ] Feature pipeline SLA confirmed
313
+ - **Risks:**
314
+ - <risk>: <mitigation>
315
+ - **Dependencies:**
316
+ - <dependency>: <owner and status>
317
+ - **Open questions:**
318
+ - <question>
319
+ - **Original request fulfilled:** Yes | Partially | No — <explanation>
320
+ - **BI dashboard handoff:** Yes — models/<project_name>/bi_engineer_handoff.md | No
321
+ - **Knowledge harvested:**
322
+ - <title> → .shards/knowledge/<type>/<filename>.md
323
+ - Or: None — project did not produce reusable knowledge
324
+ - **Status:** Complete
325
+ ```
326
+
327
+ Update specs header status to `Complete`.
328
+
329
+ ::GATE:: id=ml-engineer-phase-7 phase=7 kind=final
330
+ Read this final section back to the user. Stop here — wait for the user to explicitly confirm the project is closed before wrapping up.
331
+ ::ENDGATE::
332
+
333
+ ---
334
+
335
+ ## When this gate is confirmed
336
+
337
+ This is the final phase. Once Syn returns APPROVED sign-off, the project is complete. Do not read further files.