qualia-framework 2.6.0 → 3.2.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 (321) hide show
  1. package/CLAUDE.md +64 -0
  2. package/README.md +103 -30
  3. package/agents/builder.md +110 -0
  4. package/agents/planner.md +134 -0
  5. package/agents/qa-browser.md +186 -0
  6. package/agents/verifier.md +221 -0
  7. package/bin/cli.js +336 -531
  8. package/bin/install.js +570 -0
  9. package/bin/qualia-ui.js +299 -0
  10. package/bin/state.js +630 -0
  11. package/bin/statusline.js +252 -0
  12. package/guide.md +63 -0
  13. package/hooks/auto-update.js +139 -0
  14. package/hooks/branch-guard.js +47 -0
  15. package/hooks/migration-guard.js +60 -0
  16. package/hooks/pre-compact.js +32 -0
  17. package/hooks/pre-deploy-gate.js +110 -0
  18. package/hooks/pre-push.js +33 -0
  19. package/hooks/session-start.js +170 -0
  20. package/package.json +29 -20
  21. package/rules/design-reference.md +179 -0
  22. package/rules/frontend.md +126 -0
  23. package/skills/qualia/SKILL.md +87 -0
  24. package/skills/qualia-build/SKILL.md +97 -0
  25. package/skills/qualia-debug/SKILL.md +87 -0
  26. package/skills/qualia-design/SKILL.md +93 -0
  27. package/skills/qualia-handoff/SKILL.md +66 -0
  28. package/skills/qualia-idk/SKILL.md +8 -0
  29. package/skills/qualia-learn/SKILL.md +88 -0
  30. package/skills/qualia-new/SKILL.md +323 -0
  31. package/{framework/skills → skills}/qualia-optimize/SKILL.md +1 -1
  32. package/skills/qualia-pause/SKILL.md +63 -0
  33. package/skills/qualia-plan/SKILL.md +101 -0
  34. package/skills/qualia-polish/SKILL.md +157 -0
  35. package/skills/qualia-quick/SKILL.md +37 -0
  36. package/skills/qualia-report/SKILL.md +105 -0
  37. package/skills/qualia-resume/SKILL.md +49 -0
  38. package/skills/qualia-review/SKILL.md +76 -0
  39. package/skills/qualia-ship/SKILL.md +90 -0
  40. package/skills/qualia-skill-new/SKILL.md +167 -0
  41. package/skills/qualia-task/SKILL.md +91 -0
  42. package/skills/qualia-verify/SKILL.md +113 -0
  43. package/templates/DESIGN.md +137 -0
  44. package/templates/plan.md +28 -0
  45. package/templates/project.md +22 -0
  46. package/templates/state.md +27 -0
  47. package/templates/tracking.json +20 -0
  48. package/tests/bin.test.sh +673 -0
  49. package/tests/hooks.test.sh +315 -0
  50. package/tests/state.test.sh +535 -0
  51. package/tests/statusline.test.sh +243 -0
  52. package/bin/collect-metrics.sh +0 -62
  53. package/framework/.claudeignore +0 -51
  54. package/framework/CLAUDE.md +0 -51
  55. package/framework/MCP_SETUP.md +0 -229
  56. package/framework/agents/architecture-strategist.md +0 -53
  57. package/framework/agents/backend-agent.md +0 -150
  58. package/framework/agents/code-simplicity-reviewer.md +0 -86
  59. package/framework/agents/frontend-agent.md +0 -111
  60. package/framework/agents/kieran-typescript-reviewer.md +0 -96
  61. package/framework/agents/performance-oracle.md +0 -111
  62. package/framework/agents/qualia-codebase-mapper.md +0 -761
  63. package/framework/agents/qualia-debugger.md +0 -1204
  64. package/framework/agents/qualia-executor.md +0 -882
  65. package/framework/agents/qualia-integration-checker.md +0 -424
  66. package/framework/agents/qualia-phase-researcher.md +0 -457
  67. package/framework/agents/qualia-plan-checker.md +0 -700
  68. package/framework/agents/qualia-planner.md +0 -1245
  69. package/framework/agents/qualia-project-researcher.md +0 -603
  70. package/framework/agents/qualia-research-synthesizer.md +0 -200
  71. package/framework/agents/qualia-roadmapper.md +0 -606
  72. package/framework/agents/qualia-verifier.md +0 -686
  73. package/framework/agents/red-team-qa.md +0 -130
  74. package/framework/agents/security-auditor.md +0 -72
  75. package/framework/agents/team-orchestrator.md +0 -229
  76. package/framework/agents/teams/framework-audit-team.md +0 -66
  77. package/framework/agents/teams/full-stack-team.md +0 -48
  78. package/framework/agents/teams/optimize-team.md +0 -53
  79. package/framework/agents/teams/review-team.md +0 -70
  80. package/framework/agents/teams/ship-team.md +0 -86
  81. package/framework/agents/test-agent.md +0 -182
  82. package/framework/hooks/auto-format.sh +0 -54
  83. package/framework/hooks/block-env-edit.sh +0 -42
  84. package/framework/hooks/branch-guard.sh +0 -43
  85. package/framework/hooks/confirm-delete.sh +0 -59
  86. package/framework/hooks/migration-validate.sh +0 -77
  87. package/framework/hooks/notification-speak.sh +0 -16
  88. package/framework/hooks/pre-commit.sh +0 -100
  89. package/framework/hooks/pre-compact.sh +0 -56
  90. package/framework/hooks/pre-deploy-gate.sh +0 -160
  91. package/framework/hooks/qualia-colors.sh +0 -32
  92. package/framework/hooks/retention-cleanup.sh +0 -62
  93. package/framework/hooks/save-session-state.sh +0 -185
  94. package/framework/hooks/session-context-loader.sh +0 -96
  95. package/framework/hooks/session-learn.sh +0 -32
  96. package/framework/hooks/skill-announce.sh +0 -123
  97. package/framework/hooks/tool-error-announce.sh +0 -27
  98. package/framework/install.ps1 +0 -323
  99. package/framework/install.sh +0 -313
  100. package/framework/qualia-framework/VERSION +0 -1
  101. package/framework/qualia-framework/assets/qualia-logo.png +0 -0
  102. package/framework/qualia-framework/bin/collect-metrics.sh +0 -67
  103. package/framework/qualia-framework/bin/generate-report-docx.py +0 -429
  104. package/framework/qualia-framework/bin/qualia-tools.js +0 -2201
  105. package/framework/qualia-framework/bin/qualia-tools.test.js +0 -1054
  106. package/framework/qualia-framework/references/checkpoints.md +0 -775
  107. package/framework/qualia-framework/references/completion-checklists.md +0 -359
  108. package/framework/qualia-framework/references/continuation-format.md +0 -249
  109. package/framework/qualia-framework/references/continuation-prompt.md +0 -97
  110. package/framework/qualia-framework/references/decimal-phase-calculation.md +0 -65
  111. package/framework/qualia-framework/references/design-quality.md +0 -56
  112. package/framework/qualia-framework/references/employee-guide.md +0 -167
  113. package/framework/qualia-framework/references/git-integration.md +0 -254
  114. package/framework/qualia-framework/references/git-planning-commit.md +0 -50
  115. package/framework/qualia-framework/references/model-profile-resolution.md +0 -32
  116. package/framework/qualia-framework/references/model-profiles.md +0 -73
  117. package/framework/qualia-framework/references/phase-argument-parsing.md +0 -61
  118. package/framework/qualia-framework/references/planning-config.md +0 -195
  119. package/framework/qualia-framework/references/questioning.md +0 -141
  120. package/framework/qualia-framework/references/tdd.md +0 -263
  121. package/framework/qualia-framework/references/ui-brand.md +0 -160
  122. package/framework/qualia-framework/references/verification-patterns.md +0 -612
  123. package/framework/qualia-framework/templates/DEBUG.md +0 -159
  124. package/framework/qualia-framework/templates/DESIGN.md +0 -81
  125. package/framework/qualia-framework/templates/UAT.md +0 -247
  126. package/framework/qualia-framework/templates/codebase/architecture.md +0 -255
  127. package/framework/qualia-framework/templates/codebase/concerns.md +0 -310
  128. package/framework/qualia-framework/templates/codebase/conventions.md +0 -307
  129. package/framework/qualia-framework/templates/codebase/integrations.md +0 -280
  130. package/framework/qualia-framework/templates/codebase/stack.md +0 -186
  131. package/framework/qualia-framework/templates/codebase/structure.md +0 -285
  132. package/framework/qualia-framework/templates/codebase/testing.md +0 -480
  133. package/framework/qualia-framework/templates/config.json +0 -35
  134. package/framework/qualia-framework/templates/context.md +0 -283
  135. package/framework/qualia-framework/templates/continue-here.md +0 -78
  136. package/framework/qualia-framework/templates/debug-subagent-prompt.md +0 -91
  137. package/framework/qualia-framework/templates/discovery.md +0 -146
  138. package/framework/qualia-framework/templates/lab-notes.md +0 -16
  139. package/framework/qualia-framework/templates/milestone-archive.md +0 -123
  140. package/framework/qualia-framework/templates/milestone.md +0 -115
  141. package/framework/qualia-framework/templates/phase-prompt.md +0 -567
  142. package/framework/qualia-framework/templates/planner-subagent-prompt.md +0 -117
  143. package/framework/qualia-framework/templates/project.md +0 -184
  144. package/framework/qualia-framework/templates/projects/ai-agent.md +0 -156
  145. package/framework/qualia-framework/templates/projects/mobile-app.md +0 -181
  146. package/framework/qualia-framework/templates/projects/voice-agent.md +0 -134
  147. package/framework/qualia-framework/templates/projects/website.md +0 -137
  148. package/framework/qualia-framework/templates/requirements.md +0 -231
  149. package/framework/qualia-framework/templates/research-project/ARCHITECTURE.md +0 -204
  150. package/framework/qualia-framework/templates/research-project/FEATURES.md +0 -147
  151. package/framework/qualia-framework/templates/research-project/PITFALLS.md +0 -200
  152. package/framework/qualia-framework/templates/research-project/STACK.md +0 -120
  153. package/framework/qualia-framework/templates/research-project/SUMMARY.md +0 -170
  154. package/framework/qualia-framework/templates/research.md +0 -552
  155. package/framework/qualia-framework/templates/roadmap.md +0 -206
  156. package/framework/qualia-framework/templates/state.md +0 -179
  157. package/framework/qualia-framework/templates/summary-complex.md +0 -59
  158. package/framework/qualia-framework/templates/summary-minimal.md +0 -41
  159. package/framework/qualia-framework/templates/summary-standard.md +0 -48
  160. package/framework/qualia-framework/templates/summary.md +0 -246
  161. package/framework/qualia-framework/templates/user-setup.md +0 -311
  162. package/framework/qualia-framework/templates/verification-report.md +0 -322
  163. package/framework/qualia-framework/workflows/add-phase.md +0 -179
  164. package/framework/qualia-framework/workflows/add-todo.md +0 -157
  165. package/framework/qualia-framework/workflows/audit-milestone.md +0 -241
  166. package/framework/qualia-framework/workflows/check-todos.md +0 -176
  167. package/framework/qualia-framework/workflows/complete-milestone.md +0 -858
  168. package/framework/qualia-framework/workflows/diagnose-issues.md +0 -219
  169. package/framework/qualia-framework/workflows/discovery-phase.md +0 -289
  170. package/framework/qualia-framework/workflows/discuss-phase.md +0 -534
  171. package/framework/qualia-framework/workflows/execute-phase.md +0 -559
  172. package/framework/qualia-framework/workflows/execute-plan.md +0 -438
  173. package/framework/qualia-framework/workflows/help.md +0 -470
  174. package/framework/qualia-framework/workflows/insert-phase.md +0 -220
  175. package/framework/qualia-framework/workflows/list-phase-assumptions.md +0 -178
  176. package/framework/qualia-framework/workflows/map-codebase.md +0 -327
  177. package/framework/qualia-framework/workflows/new-milestone.md +0 -363
  178. package/framework/qualia-framework/workflows/new-project.md +0 -982
  179. package/framework/qualia-framework/workflows/pause-work.md +0 -122
  180. package/framework/qualia-framework/workflows/plan-milestone-gaps.md +0 -256
  181. package/framework/qualia-framework/workflows/plan-phase.md +0 -422
  182. package/framework/qualia-framework/workflows/progress.md +0 -389
  183. package/framework/qualia-framework/workflows/quick.md +0 -252
  184. package/framework/qualia-framework/workflows/remove-phase.md +0 -326
  185. package/framework/qualia-framework/workflows/research-phase.md +0 -74
  186. package/framework/qualia-framework/workflows/resume-project.md +0 -306
  187. package/framework/qualia-framework/workflows/set-profile.md +0 -80
  188. package/framework/qualia-framework/workflows/settings.md +0 -145
  189. package/framework/qualia-framework/workflows/transition.md +0 -556
  190. package/framework/qualia-framework/workflows/update.md +0 -197
  191. package/framework/qualia-framework/workflows/verify-phase.md +0 -195
  192. package/framework/qualia-framework/workflows/verify-work.md +0 -625
  193. package/framework/rules/context7.md +0 -14
  194. package/framework/rules/frontend.md +0 -33
  195. package/framework/rules/speed.md +0 -23
  196. package/framework/scripts/__pycache__/say.cpython-314.pyc +0 -0
  197. package/framework/scripts/apply-retention.sh +0 -120
  198. package/framework/scripts/bootstrap-pop-os.sh +0 -354
  199. package/framework/scripts/claude-voice +0 -13
  200. package/framework/scripts/cleanup.sh +0 -131
  201. package/framework/scripts/cowork-mode.sh +0 -141
  202. package/framework/scripts/generate-project-claude-md.sh +0 -153
  203. package/framework/scripts/load-test-webhook.js +0 -172
  204. package/framework/scripts/say.py +0 -236
  205. package/framework/scripts/showcase-video-recorder/ffmpeg-builder.js +0 -167
  206. package/framework/scripts/showcase-video-recorder/playwright-helpers.js +0 -216
  207. package/framework/scripts/speak.py +0 -55
  208. package/framework/scripts/speak.sh +0 -18
  209. package/framework/scripts/status.sh +0 -138
  210. package/framework/scripts/sync-to-framework.sh +0 -65
  211. package/framework/scripts/voice-hotkey.py +0 -227
  212. package/framework/scripts/voice-input.sh +0 -51
  213. package/framework/skills/animate/SKILL.md +0 -202
  214. package/framework/skills/bolder/SKILL.md +0 -144
  215. package/framework/skills/browser-qa/SKILL.md +0 -536
  216. package/framework/skills/clarify/SKILL.md +0 -179
  217. package/framework/skills/client-handoff/SKILL.md +0 -135
  218. package/framework/skills/collab-onboard/SKILL.md +0 -111
  219. package/framework/skills/colorize/SKILL.md +0 -170
  220. package/framework/skills/critique/SKILL.md +0 -126
  221. package/framework/skills/deep-research/SKILL.md +0 -240
  222. package/framework/skills/delight/SKILL.md +0 -329
  223. package/framework/skills/deploy/SKILL.md +0 -261
  224. package/framework/skills/deploy-verify/SKILL.md +0 -377
  225. package/framework/skills/deploy-verify/scripts/canary-check.sh +0 -206
  226. package/framework/skills/deploy-verify/scripts/check-console-errors.js +0 -147
  227. package/framework/skills/deploy-verify/scripts/check-cwv.js +0 -139
  228. package/framework/skills/deploy-verify/scripts/project-detect.sh +0 -84
  229. package/framework/skills/deploy-verify/scripts/verify.sh +0 -548
  230. package/framework/skills/design-quieter/SKILL.md +0 -130
  231. package/framework/skills/distill/SKILL.md +0 -149
  232. package/framework/skills/docs-lookup/SKILL.md +0 -79
  233. package/framework/skills/fcm-notifications/SKILL.md +0 -125
  234. package/framework/skills/financial-ledger/SKILL.md +0 -1039
  235. package/framework/skills/frontend-master/NOTICE.md +0 -4
  236. package/framework/skills/frontend-master/SKILL.md +0 -127
  237. package/framework/skills/frontend-master/reference/color-and-contrast.md +0 -132
  238. package/framework/skills/frontend-master/reference/interaction-design.md +0 -123
  239. package/framework/skills/frontend-master/reference/motion-design.md +0 -99
  240. package/framework/skills/frontend-master/reference/responsive-design.md +0 -114
  241. package/framework/skills/frontend-master/reference/spatial-design.md +0 -100
  242. package/framework/skills/frontend-master/reference/typography.md +0 -131
  243. package/framework/skills/frontend-master/reference/ux-writing.md +0 -107
  244. package/framework/skills/harden/SKILL.md +0 -357
  245. package/framework/skills/i18n-rtl/SKILL.md +0 -752
  246. package/framework/skills/learn/SKILL.md +0 -95
  247. package/framework/skills/memory/SKILL.md +0 -50
  248. package/framework/skills/mobile-expo/SKILL.md +0 -977
  249. package/framework/skills/mobile-expo/references/store-checklist.md +0 -550
  250. package/framework/skills/nestjs-backend/README.md +0 -73
  251. package/framework/skills/nestjs-backend/SKILL.md +0 -446
  252. package/framework/skills/nestjs-backend/references/templates.md +0 -1173
  253. package/framework/skills/normalize/SKILL.md +0 -79
  254. package/framework/skills/onboard/SKILL.md +0 -242
  255. package/framework/skills/openrouter-agent/SKILL.md +0 -922
  256. package/framework/skills/polish/SKILL.md +0 -209
  257. package/framework/skills/pr/SKILL.md +0 -66
  258. package/framework/skills/qualia/SKILL.md +0 -199
  259. package/framework/skills/qualia-add-todo/SKILL.md +0 -68
  260. package/framework/skills/qualia-audit-milestone/SKILL.md +0 -95
  261. package/framework/skills/qualia-check-todos/SKILL.md +0 -55
  262. package/framework/skills/qualia-complete-milestone/SKILL.md +0 -134
  263. package/framework/skills/qualia-debug/SKILL.md +0 -149
  264. package/framework/skills/qualia-design/SKILL.md +0 -203
  265. package/framework/skills/qualia-discuss-phase/SKILL.md +0 -72
  266. package/framework/skills/qualia-evolve/SKILL.md +0 -200
  267. package/framework/skills/qualia-execute-phase/SKILL.md +0 -89
  268. package/framework/skills/qualia-framework-audit/SKILL.md +0 -604
  269. package/framework/skills/qualia-guide/SKILL.md +0 -32
  270. package/framework/skills/qualia-help/SKILL.md +0 -114
  271. package/framework/skills/qualia-idk/SKILL.md +0 -352
  272. package/framework/skills/qualia-list-phase-assumptions/SKILL.md +0 -67
  273. package/framework/skills/qualia-new-milestone/SKILL.md +0 -72
  274. package/framework/skills/qualia-new-project/SKILL.md +0 -232
  275. package/framework/skills/qualia-pause-work/SKILL.md +0 -96
  276. package/framework/skills/qualia-plan-milestone-gaps/SKILL.md +0 -57
  277. package/framework/skills/qualia-plan-phase/SKILL.md +0 -104
  278. package/framework/skills/qualia-production-check/SKILL.md +0 -0
  279. package/framework/skills/qualia-progress/SKILL.md +0 -53
  280. package/framework/skills/qualia-quick/SKILL.md +0 -89
  281. package/framework/skills/qualia-report/SKILL.md +0 -166
  282. package/framework/skills/qualia-research-phase/SKILL.md +0 -88
  283. package/framework/skills/qualia-resume-work/SKILL.md +0 -62
  284. package/framework/skills/qualia-review/SKILL.md +0 -263
  285. package/framework/skills/qualia-start/SKILL.md +0 -161
  286. package/framework/skills/qualia-verify-work/SKILL.md +0 -132
  287. package/framework/skills/rag/SKILL.md +0 -750
  288. package/framework/skills/responsive/SKILL.md +0 -231
  289. package/framework/skills/retro/SKILL.md +0 -284
  290. package/framework/skills/sakani-conventions/SKILL.md +0 -136
  291. package/framework/skills/sakani-conventions/evals/evals.json +0 -23
  292. package/framework/skills/sakani-conventions/references/entities.md +0 -365
  293. package/framework/skills/sakani-conventions/references/error-codes.md +0 -95
  294. package/framework/skills/seo-master/SKILL.md +0 -490
  295. package/framework/skills/seo-master/references/checklist.md +0 -199
  296. package/framework/skills/seo-master/references/structured-data.md +0 -609
  297. package/framework/skills/ship/SKILL.md +0 -239
  298. package/framework/skills/stack-researcher/SKILL.md +0 -215
  299. package/framework/skills/status/SKILL.md +0 -154
  300. package/framework/skills/status/scripts/health-check.sh +0 -562
  301. package/framework/skills/subscription-payments/SKILL.md +0 -250
  302. package/framework/skills/supabase/SKILL.md +0 -973
  303. package/framework/skills/supabase/references/templates.md +0 -159
  304. package/framework/skills/team/SKILL.md +0 -67
  305. package/framework/skills/test-runner/SKILL.md +0 -202
  306. package/framework/skills/voice-agent/SKILL.md +0 -1312
  307. package/framework/skills/zoho-workflow/SKILL.md +0 -51
  308. package/framework/statusline-command.sh +0 -117
  309. package/framework/teams/default/inboxes/plan-04.json +0 -9
  310. package/framework/teams/review-team.md +0 -75
  311. package/framework/teams/ship-team.md +0 -86
  312. package/profiles/fawzi.json +0 -16
  313. package/profiles/hasan.json +0 -16
  314. package/profiles/moayad.json +0 -16
  315. package/templates/CLAUDE-owner.md +0 -52
  316. package/templates/CLAUDE.md.hbs +0 -58
  317. package/templates/env.claude.template +0 -12
  318. package/templates/settings.json +0 -172
  319. package/uninstall.sh +0 -90
  320. /package/{framework/rules → rules}/deployment.md +0 -0
  321. /package/{framework/rules → rules}/security.md +0 -0
@@ -1,137 +0,0 @@
1
- # Project Template: Website
2
-
3
- > Opinionated Next.js + Supabase + Vercel template. Fawzi's exact stack.
4
-
5
- **Stack:** Next.js 16+, React 19, TypeScript, Tailwind v4, Supabase, Vercel
6
- **Phases:** 6
7
- **Type:** website
8
-
9
- ## Phases
10
-
11
- ### Phase 1: Foundation
12
- **Goal:** Working Next.js app with auth, Supabase connected, protected routes, base layout
13
- **Skills:** [@supabase]
14
- **Tasks:**
15
- - Initialize Next.js 16+ with App Router, TypeScript strict, Tailwind v4
16
- - Configure Supabase client (server.ts + client.ts pattern from `lib/supabase/`)
17
- - Implement auth: login, signup, password reset (Supabase Auth)
18
- - Create protected route middleware (redirect unauthenticated users)
19
- - Set up base layout: header, footer, navigation shell
20
- - Configure environment variables (.env.local)
21
- - Set up RLS on auth-related tables
22
-
23
- **Success Criteria:**
24
- 1. User can create account, log in, and see protected dashboard
25
- 2. Unauthenticated users redirected to login
26
- 3. Server-side auth check works (not just client-side)
27
- 4. `npx tsc --noEmit` passes
28
-
29
- ---
30
-
31
- ### Phase 2: Landing & Marketing
32
- **Goal:** Polished public-facing pages that convert visitors
33
- **Skills:** [@frontend-master, @seo-master]
34
- **Team:** full-stack-team
35
- **Tasks:**
36
- - Hero section with distinctive typography and animations
37
- - Features section with staggered reveal animations
38
- - Testimonials/social proof section
39
- - Pricing section (if applicable)
40
- - CTA sections with micro-interactions
41
- - About/company page
42
- - Contact page with form (Supabase insert or email)
43
- - Footer with navigation, social links
44
-
45
- **Success Criteria:**
46
- 1. Landing page loads in under 3s on mobile
47
- 2. All sections have CSS transitions and staggered animations
48
- 3. No generic card grids or blue-purple gradients (Fawzi's frontend rules)
49
- 4. Distinctive fonts (not Inter/Arial)
50
- 5. Mobile-responsive from the start
51
-
52
- ---
53
-
54
- ### Phase 3: Dashboard / App
55
- **Goal:** Authenticated user area with full CRUD and real-time data
56
- **Skills:** [@admin-panel, @supabase]
57
- **Team:** full-stack-team
58
- **Tasks:**
59
- - Dashboard overview page with key metrics
60
- - Data listing pages with pagination, search, filters
61
- - Create/edit forms with Zod validation
62
- - Delete with confirmation dialog
63
- - Real-time updates (Supabase subscriptions)
64
- - User profile/settings page
65
- - Role-based access (if multi-user)
66
-
67
- **Success Criteria:**
68
- 1. User can create, read, update, delete core resources
69
- 2. Forms validate with Zod and show clear error messages
70
- 3. Data persists correctly in Supabase with RLS
71
- 4. Loading states and error boundaries on all data-fetching pages
72
-
73
- ---
74
-
75
- ### Phase 4: SEO & Performance
76
- **Goal:** Production-grade SEO and Core Web Vitals passing scores
77
- **Skills:** [@seo-master]
78
- **Tasks:**
79
- - Dynamic metadata for all pages (title, description, OG image)
80
- - JSON-LD structured data (Organization, WebSite, BreadcrumbList)
81
- - Sitemap.xml generation (dynamic from routes)
82
- - robots.txt
83
- - Open Graph and Twitter card meta tags
84
- - Image optimization (next/image, WebP, lazy loading)
85
- - Font optimization (next/font, preload critical fonts)
86
- - Bundle analysis and code splitting review
87
-
88
- **Success Criteria:**
89
- 1. Lighthouse SEO score ≥ 95
90
- 2. Core Web Vitals: LCP < 2.5s, FID < 100ms, CLS < 0.1
91
- 3. All pages have unique title and description
92
- 4. JSON-LD renders correctly in Google Rich Results Test
93
-
94
- ---
95
-
96
- ### Phase 5: Responsive & Polish
97
- **Goal:** Flawless experience across all screen sizes with refined animations
98
- **Skills:** [@responsive, @frontend-master]
99
- **Tasks:**
100
- - Mobile layout audit and fixes (320px–480px)
101
- - Tablet layout adjustments (768px–1024px)
102
- - Desktop optimization (1280px+)
103
- - Touch targets ≥ 44px on mobile
104
- - Loading skeletons for all async content
105
- - Error boundaries with recovery UI
106
- - Page transitions and route animations
107
- - Micro-interactions on buttons, links, form elements
108
- - Dark mode (if in scope)
109
-
110
- **Success Criteria:**
111
- 1. Usable on 320px width without horizontal scroll
112
- 2. Touch targets ≥ 44px on all interactive elements
113
- 3. No layout shifts on route navigation
114
- 4. Loading states visible for all data-fetching operations
115
-
116
- ---
117
-
118
- ### Phase 6: Deploy & Verify
119
- **Goal:** Production deployment with full verification suite passing
120
- **Skills:** [@deploy-verify]
121
- **Team:** ship-team
122
- **Tasks:**
123
- - Final `npx tsc --noEmit` check
124
- - Final `next lint` check
125
- - Production build (`next build`)
126
- - Deploy to Vercel (`vercel --prod`)
127
- - Configure custom domain (if applicable)
128
- - Run 6-check post-deploy verification
129
- - Supabase production config review (RLS, service key not exposed)
130
-
131
- **Success Criteria:**
132
- 1. HTTP 200 on homepage
133
- 2. Auth flow works in production
134
- 3. No console errors on key pages
135
- 4. API latency < 500ms
136
- 5. SSL certificate valid
137
- 6. No source maps exposed
@@ -1,231 +0,0 @@
1
- # Requirements Template
2
-
3
- Template for `.planning/REQUIREMENTS.md` — checkable requirements that define "done."
4
-
5
- <template>
6
-
7
- ```markdown
8
- # Requirements: [Project Name]
9
-
10
- **Defined:** [date]
11
- **Core Value:** [from PROJECT.md]
12
-
13
- ## v1 Requirements
14
-
15
- Requirements for initial release. Each maps to roadmap phases.
16
-
17
- ### Authentication
18
-
19
- - [ ] **AUTH-01**: User can sign up with email and password
20
- - [ ] **AUTH-02**: User receives email verification after signup
21
- - [ ] **AUTH-03**: User can reset password via email link
22
- - [ ] **AUTH-04**: User session persists across browser refresh
23
-
24
- ### [Category 2]
25
-
26
- - [ ] **[CAT]-01**: [Requirement description]
27
- - [ ] **[CAT]-02**: [Requirement description]
28
- - [ ] **[CAT]-03**: [Requirement description]
29
-
30
- ### [Category 3]
31
-
32
- - [ ] **[CAT]-01**: [Requirement description]
33
- - [ ] **[CAT]-02**: [Requirement description]
34
-
35
- ## v2 Requirements
36
-
37
- Deferred to future release. Tracked but not in current roadmap.
38
-
39
- ### [Category]
40
-
41
- - **[CAT]-01**: [Requirement description]
42
- - **[CAT]-02**: [Requirement description]
43
-
44
- ## Out of Scope
45
-
46
- Explicitly excluded. Documented to prevent scope creep.
47
-
48
- | Feature | Reason |
49
- |---------|--------|
50
- | [Feature] | [Why excluded] |
51
- | [Feature] | [Why excluded] |
52
-
53
- ## Traceability
54
-
55
- Which phases cover which requirements. Updated during roadmap creation.
56
-
57
- | Requirement | Phase | Status |
58
- |-------------|-------|--------|
59
- | AUTH-01 | Phase 1 | Pending |
60
- | AUTH-02 | Phase 1 | Pending |
61
- | AUTH-03 | Phase 1 | Pending |
62
- | AUTH-04 | Phase 1 | Pending |
63
- | [REQ-ID] | Phase [N] | Pending |
64
-
65
- **Coverage:**
66
- - v1 requirements: [X] total
67
- - Mapped to phases: [Y]
68
- - Unmapped: [Z] ⚠️
69
-
70
- ---
71
- *Requirements defined: [date]*
72
- *Last updated: [date] after [trigger]*
73
- ```
74
-
75
- </template>
76
-
77
- <guidelines>
78
-
79
- **Requirement Format:**
80
- - ID: `[CATEGORY]-[NUMBER]` (AUTH-01, CONTENT-02, SOCIAL-03)
81
- - Description: User-centric, testable, atomic
82
- - Checkbox: Only for v1 requirements (v2 are not yet actionable)
83
-
84
- **Categories:**
85
- - Derive from research FEATURES.md categories
86
- - Keep consistent with domain conventions
87
- - Typical: Authentication, Content, Social, Notifications, Moderation, Payments, Admin
88
-
89
- **v1 vs v2:**
90
- - v1: Committed scope, will be in roadmap phases
91
- - v2: Acknowledged but deferred, not in current roadmap
92
- - Moving v2 → v1 requires roadmap update
93
-
94
- **Out of Scope:**
95
- - Explicit exclusions with reasoning
96
- - Prevents "why didn't you include X?" later
97
- - Anti-features from research belong here with warnings
98
-
99
- **Traceability:**
100
- - Empty initially, populated during roadmap creation
101
- - Each requirement maps to exactly one phase
102
- - Unmapped requirements = roadmap gap
103
-
104
- **Status Values:**
105
- - Pending: Not started
106
- - In Progress: Phase is active
107
- - Complete: Requirement verified
108
- - Blocked: Waiting on external factor
109
-
110
- </guidelines>
111
-
112
- <evolution>
113
-
114
- **After each phase completes:**
115
- 1. Mark covered requirements as Complete
116
- 2. Update traceability status
117
- 3. Note any requirements that changed scope
118
-
119
- **After roadmap updates:**
120
- 1. Verify all v1 requirements still mapped
121
- 2. Add new requirements if scope expanded
122
- 3. Move requirements to v2/out of scope if descoped
123
-
124
- **Requirement completion criteria:**
125
- - Requirement is "Complete" when:
126
- - Feature is implemented
127
- - Feature is verified (tests pass, manual check done)
128
- - Feature is committed
129
-
130
- </evolution>
131
-
132
- <example>
133
-
134
- ```markdown
135
- # Requirements: CommunityApp
136
-
137
- **Defined:** 2025-01-14
138
- **Core Value:** Users can share and discuss content with people who share their interests
139
-
140
- ## v1 Requirements
141
-
142
- ### Authentication
143
-
144
- - [ ] **AUTH-01**: User can sign up with email and password
145
- - [ ] **AUTH-02**: User receives email verification after signup
146
- - [ ] **AUTH-03**: User can reset password via email link
147
- - [ ] **AUTH-04**: User session persists across browser refresh
148
-
149
- ### Profiles
150
-
151
- - [ ] **PROF-01**: User can create profile with display name
152
- - [ ] **PROF-02**: User can upload avatar image
153
- - [ ] **PROF-03**: User can write bio (max 500 chars)
154
- - [ ] **PROF-04**: User can view other users' profiles
155
-
156
- ### Content
157
-
158
- - [ ] **CONT-01**: User can create text post
159
- - [ ] **CONT-02**: User can upload image with post
160
- - [ ] **CONT-03**: User can edit own posts
161
- - [ ] **CONT-04**: User can delete own posts
162
- - [ ] **CONT-05**: User can view feed of posts
163
-
164
- ### Social
165
-
166
- - [ ] **SOCL-01**: User can follow other users
167
- - [ ] **SOCL-02**: User can unfollow users
168
- - [ ] **SOCL-03**: User can like posts
169
- - [ ] **SOCL-04**: User can comment on posts
170
- - [ ] **SOCL-05**: User can view activity feed (followed users' posts)
171
-
172
- ## v2 Requirements
173
-
174
- ### Notifications
175
-
176
- - **NOTF-01**: User receives in-app notifications
177
- - **NOTF-02**: User receives email for new followers
178
- - **NOTF-03**: User receives email for comments on own posts
179
- - **NOTF-04**: User can configure notification preferences
180
-
181
- ### Moderation
182
-
183
- - **MODR-01**: User can report content
184
- - **MODR-02**: User can block other users
185
- - **MODR-03**: Admin can view reported content
186
- - **MODR-04**: Admin can remove content
187
- - **MODR-05**: Admin can ban users
188
-
189
- ## Out of Scope
190
-
191
- | Feature | Reason |
192
- |---------|--------|
193
- | Real-time chat | High complexity, not core to community value |
194
- | Video posts | Storage/bandwidth costs, defer to v2+ |
195
- | OAuth login | Email/password sufficient for v1 |
196
- | Mobile app | Web-first, mobile later |
197
-
198
- ## Traceability
199
-
200
- | Requirement | Phase | Status |
201
- |-------------|-------|--------|
202
- | AUTH-01 | Phase 1 | Pending |
203
- | AUTH-02 | Phase 1 | Pending |
204
- | AUTH-03 | Phase 1 | Pending |
205
- | AUTH-04 | Phase 1 | Pending |
206
- | PROF-01 | Phase 2 | Pending |
207
- | PROF-02 | Phase 2 | Pending |
208
- | PROF-03 | Phase 2 | Pending |
209
- | PROF-04 | Phase 2 | Pending |
210
- | CONT-01 | Phase 3 | Pending |
211
- | CONT-02 | Phase 3 | Pending |
212
- | CONT-03 | Phase 3 | Pending |
213
- | CONT-04 | Phase 3 | Pending |
214
- | CONT-05 | Phase 3 | Pending |
215
- | SOCL-01 | Phase 4 | Pending |
216
- | SOCL-02 | Phase 4 | Pending |
217
- | SOCL-03 | Phase 4 | Pending |
218
- | SOCL-04 | Phase 4 | Pending |
219
- | SOCL-05 | Phase 4 | Pending |
220
-
221
- **Coverage:**
222
- - v1 requirements: 18 total
223
- - Mapped to phases: 18
224
- - Unmapped: 0 ✓
225
-
226
- ---
227
- *Requirements defined: 2025-01-14*
228
- *Last updated: 2025-01-14 after initial definition*
229
- ```
230
-
231
- </example>
@@ -1,204 +0,0 @@
1
- # Architecture Research Template
2
-
3
- Template for `.planning/research/ARCHITECTURE.md` — system structure patterns for the project domain.
4
-
5
- <template>
6
-
7
- ```markdown
8
- # Architecture Research
9
-
10
- **Domain:** [domain type]
11
- **Researched:** [date]
12
- **Confidence:** [HIGH/MEDIUM/LOW]
13
-
14
- ## Standard Architecture
15
-
16
- ### System Overview
17
-
18
- ```
19
- ┌─────────────────────────────────────────────────────────────┐
20
- │ [Layer Name] │
21
- ├─────────────────────────────────────────────────────────────┤
22
- │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
23
- │ │ [Comp] │ │ [Comp] │ │ [Comp] │ │ [Comp] │ │
24
- │ └────┬────┘ └────┬────┘ └────┬────┘ └────┬────┘ │
25
- │ │ │ │ │ │
26
- ├───────┴────────────┴────────────┴────────────┴──────────────┤
27
- │ [Layer Name] │
28
- ├─────────────────────────────────────────────────────────────┤
29
- │ ┌─────────────────────────────────────────────────────┐ │
30
- │ │ [Component] │ │
31
- │ └─────────────────────────────────────────────────────┘ │
32
- ├─────────────────────────────────────────────────────────────┤
33
- │ [Layer Name] │
34
- │ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
35
- │ │ [Store] │ │ [Store] │ │ [Store] │ │
36
- │ └──────────┘ └──────────┘ └──────────┘ │
37
- └─────────────────────────────────────────────────────────────┘
38
- ```
39
-
40
- ### Component Responsibilities
41
-
42
- | Component | Responsibility | Typical Implementation |
43
- |-----------|----------------|------------------------|
44
- | [name] | [what it owns] | [how it's usually built] |
45
- | [name] | [what it owns] | [how it's usually built] |
46
- | [name] | [what it owns] | [how it's usually built] |
47
-
48
- ## Recommended Project Structure
49
-
50
- ```
51
- src/
52
- ├── [folder]/ # [purpose]
53
- │ ├── [subfolder]/ # [purpose]
54
- │ └── [file].ts # [purpose]
55
- ├── [folder]/ # [purpose]
56
- │ ├── [subfolder]/ # [purpose]
57
- │ └── [file].ts # [purpose]
58
- ├── [folder]/ # [purpose]
59
- └── [folder]/ # [purpose]
60
- ```
61
-
62
- ### Structure Rationale
63
-
64
- - **[folder]/:** [why organized this way]
65
- - **[folder]/:** [why organized this way]
66
-
67
- ## Architectural Patterns
68
-
69
- ### Pattern 1: [Pattern Name]
70
-
71
- **What:** [description]
72
- **When to use:** [conditions]
73
- **Trade-offs:** [pros and cons]
74
-
75
- **Example:**
76
- ```typescript
77
- // [Brief code example showing the pattern]
78
- ```
79
-
80
- ### Pattern 2: [Pattern Name]
81
-
82
- **What:** [description]
83
- **When to use:** [conditions]
84
- **Trade-offs:** [pros and cons]
85
-
86
- **Example:**
87
- ```typescript
88
- // [Brief code example showing the pattern]
89
- ```
90
-
91
- ### Pattern 3: [Pattern Name]
92
-
93
- **What:** [description]
94
- **When to use:** [conditions]
95
- **Trade-offs:** [pros and cons]
96
-
97
- ## Data Flow
98
-
99
- ### Request Flow
100
-
101
- ```
102
- [User Action]
103
-
104
- [Component] → [Handler] → [Service] → [Data Store]
105
- ↓ ↓ ↓ ↓
106
- [Response] ← [Transform] ← [Query] ← [Database]
107
- ```
108
-
109
- ### State Management
110
-
111
- ```
112
- [State Store]
113
- ↓ (subscribe)
114
- [Components] ←→ [Actions] → [Reducers/Mutations] → [State Store]
115
- ```
116
-
117
- ### Key Data Flows
118
-
119
- 1. **[Flow name]:** [description of how data moves]
120
- 2. **[Flow name]:** [description of how data moves]
121
-
122
- ## Scaling Considerations
123
-
124
- | Scale | Architecture Adjustments |
125
- |-------|--------------------------|
126
- | 0-1k users | [approach — usually monolith is fine] |
127
- | 1k-100k users | [approach — what to optimize first] |
128
- | 100k+ users | [approach — when to consider splitting] |
129
-
130
- ### Scaling Priorities
131
-
132
- 1. **First bottleneck:** [what breaks first, how to fix]
133
- 2. **Second bottleneck:** [what breaks next, how to fix]
134
-
135
- ## Anti-Patterns
136
-
137
- ### Anti-Pattern 1: [Name]
138
-
139
- **What people do:** [the mistake]
140
- **Why it's wrong:** [the problem it causes]
141
- **Do this instead:** [the correct approach]
142
-
143
- ### Anti-Pattern 2: [Name]
144
-
145
- **What people do:** [the mistake]
146
- **Why it's wrong:** [the problem it causes]
147
- **Do this instead:** [the correct approach]
148
-
149
- ## Integration Points
150
-
151
- ### External Services
152
-
153
- | Service | Integration Pattern | Notes |
154
- |---------|---------------------|-------|
155
- | [service] | [how to connect] | [gotchas] |
156
- | [service] | [how to connect] | [gotchas] |
157
-
158
- ### Internal Boundaries
159
-
160
- | Boundary | Communication | Notes |
161
- |----------|---------------|-------|
162
- | [module A ↔ module B] | [API/events/direct] | [considerations] |
163
-
164
- ## Sources
165
-
166
- - [Architecture references]
167
- - [Official documentation]
168
- - [Case studies]
169
-
170
- ---
171
- *Architecture research for: [domain]*
172
- *Researched: [date]*
173
- ```
174
-
175
- </template>
176
-
177
- <guidelines>
178
-
179
- **System Overview:**
180
- - Use ASCII box-drawing diagrams for clarity (├── └── │ ─ for structure visualization only)
181
- - Show major components and their relationships
182
- - Don't over-detail — this is conceptual, not implementation
183
-
184
- **Project Structure:**
185
- - Be specific about folder organization
186
- - Explain the rationale for grouping
187
- - Match conventions of the chosen stack
188
-
189
- **Patterns:**
190
- - Include code examples where helpful
191
- - Explain trade-offs honestly
192
- - Note when patterns are overkill for small projects
193
-
194
- **Scaling Considerations:**
195
- - Be realistic — most projects don't need to scale to millions
196
- - Focus on "what breaks first" not theoretical limits
197
- - Avoid premature optimization recommendations
198
-
199
- **Anti-Patterns:**
200
- - Specific to this domain
201
- - Include what to do instead
202
- - Helps prevent common mistakes during implementation
203
-
204
- </guidelines>