@cakemail-org/cakemail-cli 1.7.0 β†’ 2.0.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 (198) hide show
  1. package/.claude/settings.local.json +12 -0
  2. package/.env.example +40 -0
  3. package/.env.test.example +45 -0
  4. package/CHANGELOG.md +1031 -0
  5. package/README.md +41 -37
  6. package/audit-formats.js +128 -0
  7. package/cakemail.rb +20 -0
  8. package/dist/client.js +1 -1
  9. package/dist/client.js.map +1 -1
  10. package/dist/commands/account.js +1 -1
  11. package/dist/commands/account.js.map +1 -1
  12. package/dist/commands/attributes.js +1 -1
  13. package/dist/commands/attributes.js.map +1 -1
  14. package/dist/commands/campaigns.js +1 -1
  15. package/dist/commands/campaigns.js.map +1 -1
  16. package/dist/commands/contacts.js +1 -1
  17. package/dist/commands/contacts.js.map +1 -1
  18. package/dist/commands/emails.js +1 -1
  19. package/dist/commands/emails.js.map +1 -1
  20. package/dist/commands/interests.js +1 -1
  21. package/dist/commands/interests.js.map +1 -1
  22. package/dist/commands/lists.js +1 -1
  23. package/dist/commands/lists.js.map +1 -1
  24. package/dist/commands/logs.js +1 -1
  25. package/dist/commands/logs.js.map +1 -1
  26. package/dist/commands/reports.js +1 -1
  27. package/dist/commands/reports.js.map +1 -1
  28. package/dist/commands/segments.js +1 -1
  29. package/dist/commands/segments.js.map +1 -1
  30. package/dist/commands/senders.js +1 -1
  31. package/dist/commands/senders.js.map +1 -1
  32. package/dist/commands/suppressed.js +1 -1
  33. package/dist/commands/suppressed.js.map +1 -1
  34. package/dist/commands/tags.js +1 -1
  35. package/dist/commands/tags.js.map +1 -1
  36. package/dist/commands/templates.js +1 -1
  37. package/dist/commands/templates.js.map +1 -1
  38. package/dist/commands/transactional-templates.js +1 -1
  39. package/dist/commands/transactional-templates.js.map +1 -1
  40. package/dist/commands/webhooks.js +1 -1
  41. package/dist/commands/webhooks.js.map +1 -1
  42. package/dist/utils/config.js +2 -2
  43. package/dist/utils/config.js.map +1 -1
  44. package/dist/utils/errors.js +1 -1
  45. package/dist/utils/errors.js.map +1 -1
  46. package/dist/utils/progress.d.ts.map +1 -1
  47. package/dist/utils/progress.js +32 -4
  48. package/dist/utils/progress.js.map +1 -1
  49. package/dist/utils/spinner.d.ts +17 -0
  50. package/dist/utils/spinner.d.ts.map +1 -0
  51. package/dist/utils/spinner.js +43 -0
  52. package/dist/utils/spinner.js.map +1 -0
  53. package/docs/DOCUMENTATION-STANDARD.md +1068 -0
  54. package/docs/README.md +161 -0
  55. package/docs/developer/ARCHITECTURE.md +516 -0
  56. package/docs/developer/AUTH.md +204 -0
  57. package/docs/developer/CONTRIBUTING.md +227 -0
  58. package/docs/developer/DOCUMENTATION_SUMMARY.md +346 -0
  59. package/docs/developer/PROJECT_INDEX.md +365 -0
  60. package/docs/planning/API_COVERAGE.md +1045 -0
  61. package/docs/planning/BACKLOG.md +1159 -0
  62. package/docs/planning/PROFILE_SYSTEM_TASKS.md +287 -0
  63. package/docs/planning/UX_IMPLEMENTATION_PLAN.md +691 -0
  64. package/docs/planning/archive/RELEASE_CHECKLIST_v1.3.0.md +332 -0
  65. package/docs/planning/archive/RELEASE_v1.3.0.md +428 -0
  66. package/docs/planning/archive/cakemail-cli-ux-improvements.md +438 -0
  67. package/docs/planning/cakemail-profile-system-plan.md +1121 -0
  68. package/docs/testing/AI_USER_SIMULATION_DESIGN.md +1342 -0
  69. package/docs/testing/KENOGAMI_BIDIRECTIONAL_FLOW.md +1517 -0
  70. package/docs/testing/KENOGAMI_TRUTH_RECONCILIATION_SYSTEM.md +1369 -0
  71. package/docs/user-manual/.obsidian/app.json +1 -0
  72. package/docs/user-manual/.obsidian/appearance.json +1 -0
  73. package/docs/user-manual/.obsidian/core-plugins.json +33 -0
  74. package/docs/user-manual/.obsidian/workspace.json +167 -0
  75. package/docs/user-manual/01-getting-started/01-installation.md +214 -0
  76. package/docs/user-manual/01-getting-started/02-quick-start.md +432 -0
  77. package/docs/user-manual/01-getting-started/03-authentication.md +448 -0
  78. package/docs/user-manual/01-getting-started/04-configuration.md +430 -0
  79. package/docs/user-manual/01-getting-started/05-output-formats.md +447 -0
  80. package/docs/user-manual/02-core-concepts/01-accounts.md +514 -0
  81. package/docs/user-manual/02-core-concepts/02-profile-system.md +771 -0
  82. package/docs/user-manual/02-core-concepts/03-smart-defaults.md +485 -0
  83. package/docs/user-manual/02-core-concepts/04-authentication-methods.md +435 -0
  84. package/docs/user-manual/02-core-concepts/05-pagination-filtering.md +600 -0
  85. package/docs/user-manual/02-core-concepts/06-error-handling.md +718 -0
  86. package/docs/user-manual/02-core-concepts/07-api-coverage.md +483 -0
  87. package/docs/user-manual/03-email-operations/01-senders.md +490 -0
  88. package/docs/user-manual/03-email-operations/02-templates.md +444 -0
  89. package/docs/user-manual/03-email-operations/03-transactional-emails.md +706 -0
  90. package/docs/user-manual/03-email-operations/04-email-tracking.md +407 -0
  91. package/docs/user-manual/04-campaign-management/01-campaigns-basics.md +394 -0
  92. package/docs/user-manual/04-campaign-management/02-campaign-scheduling.md +630 -0
  93. package/docs/user-manual/04-campaign-management/03-campaign-testing.md +997 -0
  94. package/docs/user-manual/04-campaign-management/04-campaign-lifecycle.md +709 -0
  95. package/docs/user-manual/04-campaign-management/05-campaign-links.md +934 -0
  96. package/docs/user-manual/05-contact-management/01-lists.md +836 -0
  97. package/docs/user-manual/05-contact-management/02-contacts.md +1035 -0
  98. package/docs/user-manual/05-contact-management/03-custom-attributes.md +788 -0
  99. package/docs/user-manual/05-contact-management/04-segments.md +1028 -0
  100. package/docs/user-manual/05-contact-management/05-contact-import-export.md +1031 -0
  101. package/docs/user-manual/06-analytics-reporting/01-campaign-analytics.md +867 -0
  102. package/docs/user-manual/06-analytics-reporting/02-account-reports.md +227 -0
  103. package/docs/user-manual/07-integrations/01-webhooks-integration.md +259 -0
  104. package/docs/user-manual/07-integrations/02-automation.md +326 -0
  105. package/docs/user-manual/08-advanced-usage/01-scripting-patterns.md +672 -0
  106. package/docs/user-manual/08-advanced-usage/02-bulk-operations.md +932 -0
  107. package/docs/user-manual/08-advanced-usage/03-ci-cd-integration.md +892 -0
  108. package/docs/user-manual/08-advanced-usage/04-performance-optimization.md +766 -0
  109. package/docs/user-manual/09-command-reference/01-config.md +776 -0
  110. package/docs/user-manual/09-command-reference/02-account.md +652 -0
  111. package/docs/user-manual/09-command-reference/03-lists.md +958 -0
  112. package/docs/user-manual/09-command-reference/04-contacts.md +1408 -0
  113. package/docs/user-manual/09-command-reference/05-attributes.md +617 -0
  114. package/docs/user-manual/09-command-reference/06-segments.md +894 -0
  115. package/docs/user-manual/09-command-reference/07-senders.md +803 -0
  116. package/docs/user-manual/09-command-reference/08-templates.md +818 -0
  117. package/docs/user-manual/09-command-reference/09-campaigns.md +1250 -0
  118. package/docs/user-manual/09-command-reference/10-emails.md +807 -0
  119. package/docs/user-manual/09-command-reference/11-reports.md +1135 -0
  120. package/docs/user-manual/09-command-reference/12-webhooks.md +773 -0
  121. package/docs/user-manual/09-command-reference/13-suppressed.md +797 -0
  122. package/docs/user-manual/09-command-reference/14-interests.md +630 -0
  123. package/docs/user-manual/09-command-reference/15-tags.md +584 -0
  124. package/docs/user-manual/09-command-reference/16-logs.md +656 -0
  125. package/docs/user-manual/09-command-reference/17-transactional-templates.md +850 -0
  126. package/docs/user-manual/10-troubleshooting/01-common-errors.md +457 -0
  127. package/docs/user-manual/10-troubleshooting/02-authentication-issues.md +558 -0
  128. package/docs/user-manual/10-troubleshooting/03-connection-problems.md +634 -0
  129. package/docs/user-manual/10-troubleshooting/04-debugging.md +725 -0
  130. package/docs/user-manual/11-appendix/04-faq.md +484 -0
  131. package/docs/user-manual/11-appendix/05-glossary.md +250 -0
  132. package/docs/user-manual/README.md +0 -0
  133. package/package.json +13 -61
  134. package/src/cli.ts +125 -0
  135. package/src/client.ts +16 -0
  136. package/src/commands/account.ts +267 -0
  137. package/src/commands/accounts.ts +78 -0
  138. package/src/commands/actions.ts +249 -0
  139. package/src/commands/attributes.ts +139 -0
  140. package/src/commands/campaign-blueprints.ts +106 -0
  141. package/src/commands/campaigns.ts +469 -0
  142. package/src/commands/config.ts +77 -0
  143. package/src/commands/contacts.ts +612 -0
  144. package/src/commands/custom-attributes.ts +127 -0
  145. package/src/commands/dkims.ts +117 -0
  146. package/src/commands/domains.ts +82 -0
  147. package/src/commands/email-apis.ts +569 -0
  148. package/src/commands/emails.ts +197 -0
  149. package/src/commands/forms.ts +283 -0
  150. package/src/commands/interests.ts +155 -0
  151. package/src/commands/links.ts +38 -0
  152. package/src/commands/lists.ts +406 -0
  153. package/src/commands/logos.ts +71 -0
  154. package/src/commands/logs.ts +386 -0
  155. package/src/commands/reports.ts +306 -0
  156. package/src/commands/segments.ts +158 -0
  157. package/src/commands/senders.ts +204 -0
  158. package/src/commands/sub-accounts.ts +271 -0
  159. package/src/commands/suppressed-emails.ts +234 -0
  160. package/src/commands/suppressed.ts +198 -0
  161. package/src/commands/system-emails.ts +85 -0
  162. package/src/commands/tags.ts +146 -0
  163. package/src/commands/tasks.ts +116 -0
  164. package/src/commands/templates.ts +189 -0
  165. package/src/commands/tokens.ts +83 -0
  166. package/src/commands/transactional-emails.ts +374 -0
  167. package/src/commands/transactional-templates.ts +385 -0
  168. package/src/commands/users.ts +506 -0
  169. package/src/commands/webhooks.ts +172 -0
  170. package/src/commands/workflow-blueprints.ts +123 -0
  171. package/src/commands/workflows.ts +265 -0
  172. package/src/types/profile.ts +93 -0
  173. package/src/utils/auth.ts +272 -0
  174. package/src/utils/config-file.ts +96 -0
  175. package/src/utils/config.ts +134 -0
  176. package/src/utils/confirm.ts +32 -0
  177. package/src/utils/defaults.ts +99 -0
  178. package/src/utils/errors.ts +116 -0
  179. package/src/utils/interactive.ts +91 -0
  180. package/src/utils/list-defaults.ts +74 -0
  181. package/src/utils/output.ts +190 -0
  182. package/src/utils/progress.ts +320 -0
  183. package/src/utils/spinner.ts +22 -0
  184. package/tests/IMPLEMENTATION_STATUS.md +258 -0
  185. package/tests/PTY_SETUP.md +118 -0
  186. package/tests/PTY_TESTING_GUIDE.md +507 -0
  187. package/tests/README.md +244 -0
  188. package/tests/fixtures/api-responses/campaigns.json +34 -0
  189. package/tests/fixtures/test-config.json +13 -0
  190. package/tests/helpers/cli-runner.ts +128 -0
  191. package/tests/helpers/mock-server.ts +301 -0
  192. package/tests/helpers/pty-runner.ts +181 -0
  193. package/tests/integration/campaigns-real-api.test.ts +196 -0
  194. package/tests/integration/setup-integration.ts +50 -0
  195. package/tests/pty/campaigns.test.ts +241 -0
  196. package/tests/setup.ts +34 -0
  197. package/tsconfig.json +15 -0
  198. package/vitest.config.ts +28 -0
@@ -0,0 +1,346 @@
1
+ # Cakemail CLI - Documentation System Summary
2
+
3
+ **Created:** 2025-10-11
4
+ **Purpose:** Explain how all documentation files work together
5
+
6
+ ---
7
+
8
+ ## 🎯 Your Questions Answered
9
+
10
+ ### Q: "Will a new AI have all required context to continue work effectively?"
11
+
12
+ **A: YES.** Here's how:
13
+
14
+ 1. **Start with [PROJECT_INDEX.md](./PROJECT_INDEX.md)** (10 min read)
15
+ - Maps ALL documentation
16
+ - Shows relationships between files
17
+ - Provides decision trees
18
+ - **Result:** 80% of context
19
+
20
+ 2. **Then read [BACKLOG.md](../planning/BACKLOG.md)** (15 min read)
21
+ - Self-contained feature descriptions
22
+ - Clear priorities and status
23
+ - Effort estimates and dependencies
24
+ - **Result:** 95% of context
25
+
26
+ 3. **Optional: Read detailed plans** (10-20 min each)
27
+ - [UX_IMPLEMENTATION_PLAN.md](../planning/UX_IMPLEMENTATION_PLAN.md) (for UX work)
28
+ - [API_COVERAGE.md](../planning/API_COVERAGE.md) (for API work)
29
+ - [PROFILE_SYSTEM_PLAN.md](../planning/cakemail-profile-system-plan.md) (for profile work)
30
+ - **Result:** 100% of context
31
+
32
+ **Total onboarding time:** 20-45 minutes depending on depth needed.
33
+
34
+ ---
35
+
36
+ ### Q: "Are the other files referenced correctly?"
37
+
38
+ **A: YES.** Here's the verification:
39
+
40
+ ```
41
+ PROJECT_INDEX.md
42
+ β”œβ”€β”€ References ../../README.md βœ“
43
+ β”œβ”€β”€ References ./ARCHITECTURE.md βœ“
44
+ β”œβ”€β”€ References ../../CHANGELOG.md βœ“
45
+ β”œβ”€β”€ References ../planning/BACKLOG.md βœ“
46
+ β”œβ”€β”€ References ../planning/API_COVERAGE.md βœ“
47
+ β”œβ”€β”€ References ../planning/UX_IMPLEMENTATION_PLAN.md βœ“
48
+ β”œβ”€β”€ References ../planning/cakemail-profile-system-plan.md βœ“
49
+ └── References ./CONTRIBUTING.md βœ“
50
+
51
+ BACKLOG.md
52
+ β”œβ”€β”€ References UX_IMPLEMENTATION_PLAN.md βœ“ (line 78)
53
+ β”œβ”€β”€ References API_COVERAGE.md βœ“ (line 309)
54
+ β”œβ”€β”€ References cakemail-profile-system-plan.md βœ“ (line 505)
55
+ β”œβ”€β”€ References PROFILE_SYSTEM_TASKS.md βœ“ (line 505)
56
+ β”œβ”€β”€ References PROJECT_INDEX.md βœ“ (line 1070)
57
+ β”œβ”€β”€ References CHANGELOG.md βœ“ (line 1072)
58
+ └── Self-contained descriptions βœ“ (can work standalone)
59
+ ```
60
+
61
+ **All cross-references are valid and working.**
62
+
63
+ ---
64
+
65
+ ### Q: "Does BACKLOG.md work well in pair with CHANGELOG.md?"
66
+
67
+ **A: YES.** They form a **Past ← β†’ Future** relationship:
68
+
69
+ ```
70
+ CHANGELOG.md BACKLOG.md
71
+ (PAST - Shipped) (FUTURE - Planned)
72
+ ───────────────── ─────────────────
73
+
74
+ v1.4.0 βœ… v1.4.0 remaining ⚠️
75
+ - Enhanced output - Interactive auth setup
76
+ - Smart defaults - Natural date parsing
77
+ - Confirmations - Quickstart wizard
78
+
79
+ v1.3.0 βœ… v1.5.0 planned πŸ“‹
80
+ - Reports - Profile system
81
+ - Segments - Email preview
82
+ - Import/Export - Search commands
83
+
84
+ v1.2.0 βœ… v1.6.0+ planned πŸ“‹
85
+ ... - Workflows
86
+ - Shell completion
87
+ - Config management
88
+ ```
89
+
90
+ **Synchronization Process** (documented in [BACKLOG.md](../planning/BACKLOG.md) lines 995-1039):
91
+
92
+ 1. **Planning:** Feature in [BACKLOG.md](../planning/BACKLOG.md) β†’ Status: NOT STARTED
93
+ 2. **Dev:** [BACKLOG.md](../planning/BACKLOG.md) β†’ Status: IN PROGRESS
94
+ 3. **Complete:** [BACKLOG.md](../planning/BACKLOG.md) β†’ Status: βœ… COMPLETED + [CHANGELOG.md](../../CHANGELOG.md) β†’ [Unreleased]
95
+ 4. **Release:** [BACKLOG.md](../planning/BACKLOG.md) β†’ Remove/Archive + [CHANGELOG.md](../../CHANGELOG.md) β†’ [v1.X.0]
96
+
97
+ **This ensures:**
98
+ - βœ… No features get lost
99
+ - βœ… Clear audit trail
100
+ - βœ… Easy to see what's done vs planned
101
+ - βœ… Automatic documentation
102
+
103
+ ---
104
+
105
+ ### Q: "How can we ensure this works long-term?"
106
+
107
+ **A: Built-in maintenance process:**
108
+
109
+ ### Weekly Maintenance (5 minutes)
110
+ ```bash
111
+ # 1. Update BACKLOG.md statuses
112
+ grep "IN PROGRESS" docs/planning/BACKLOG.md # Check active work
113
+ # Mark completed items [x]
114
+
115
+ # 2. Move completed to CHANGELOG.md
116
+ # Copy from BACKLOG completed items β†’ CHANGELOG [Unreleased]
117
+
118
+ # 3. Update PROJECT_INDEX.md "Current State"
119
+ # Reflect latest version and status
120
+ ```
121
+
122
+ ### Before Each Release (30 minutes)
123
+ ```bash
124
+ # 1. Finalize CHANGELOG.md
125
+ # Move [Unreleased] β†’ [v1.X.0] with date
126
+
127
+ # 2. Archive BACKLOG.md completed items
128
+ # Remove βœ… COMPLETED items or move to "Recently Completed"
129
+
130
+ # 3. Update all version numbers
131
+ # package.json, docs/developer/PROJECT_INDEX.md, docs/planning/BACKLOG.md
132
+
133
+ # 4. Follow marketing checklist in docs/planning/BACKLOG.md (lines 963-989)
134
+ ```
135
+
136
+ ### Quarterly Review (1-2 hours)
137
+ ```bash
138
+ # 1. Review all docs for accuracy
139
+ # 2. Archive outdated planning docs to docs/planning/archive/
140
+ # 3. Update priority matrix in docs/planning/BACKLOG.md
141
+ # 4. Clean up duplicate/obsolete docs
142
+ # 5. Verify all cross-references still valid
143
+ ```
144
+
145
+ ---
146
+
147
+ ## πŸ“Š Documentation System Overview
148
+
149
+ ### The Core Triangle
150
+
151
+ ```
152
+ docs/developer/PROJECT_INDEX.md
153
+ (Navigation Hub)
154
+ ↓
155
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”
156
+ ↓ ↓
157
+ CHANGELOG.md docs/planning/BACKLOG.md
158
+ (The Past) (The Future)
159
+ ↑ ↓
160
+ β””β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜
161
+ ↓
162
+ Implementation
163
+ (The Present)
164
+ ```
165
+
166
+ ### Supporting Documents
167
+
168
+ ```
169
+ Implementation Details (docs/developer/):
170
+ β”œβ”€β”€ ARCHITECTURE.md (how code is organized)
171
+ β”œβ”€β”€ CONTRIBUTING.md (how to contribute)
172
+ └── AUTH.md (authentication reference)
173
+
174
+ Feature Planning (docs/planning/):
175
+ β”œβ”€β”€ UX_IMPLEMENTATION_PLAN.md (detailed UX roadmap)
176
+ β”œβ”€β”€ API_COVERAGE.md (detailed API roadmap)
177
+ β”œβ”€β”€ cakemail-profile-system-plan.md (profile system design)
178
+ └── PROFILE_SYSTEM_TASKS.md (profile tasks breakdown)
179
+ ```
180
+
181
+ ---
182
+
183
+ ## πŸ€– AI Handoff Scenarios
184
+
185
+ ### Scenario 1: "Continue the current work"
186
+
187
+ **AI reads:**
188
+ 1. [PROJECT_INDEX.md](./PROJECT_INDEX.md) (10 min) - Get orientation
189
+ 2. [BACKLOG.md](../planning/BACKLOG.md) "🎯 Current Focus" section (2 min) - See what's active
190
+ 3. Relevant detailed plan (10 min) - Get specifics
191
+
192
+ **Result:** Can continue work in ~22 minutes
193
+
194
+ ---
195
+
196
+ ### Scenario 2: "Pick something new to work on"
197
+
198
+ **AI reads:**
199
+ 1. [PROJECT_INDEX.md](./PROJECT_INDEX.md) (10 min) - Get orientation
200
+ 2. [BACKLOG.md](../planning/BACKLOG.md) "Priority Matrix" (5 min) - See priorities
201
+ 3. [BACKLOG.md](../planning/BACKLOG.md) feature description (5 min) - Understand feature
202
+ 4. [CHANGELOG.md](../../CHANGELOG.md) (5 min) - Understand what exists
203
+
204
+ **Result:** Can start new work in ~25 minutes
205
+
206
+ ---
207
+
208
+ ### Scenario 3: "Create marketing materials for a feature"
209
+
210
+ **AI reads:**
211
+ 1. [CHANGELOG.md](../../CHANGELOG.md) entry for feature (2 min) - What shipped
212
+ 2. [BACKLOG.md](../planning/BACKLOG.md) "Documentation & Marketing" section (10 min) - Templates
213
+ 3. Original feature plan (optional, 10 min) - Deep context
214
+
215
+ **Result:** Can create materials in ~12-22 minutes
216
+
217
+ ---
218
+
219
+ ## βœ… Verification Checklist
220
+
221
+ Use this to verify everything is working:
222
+
223
+ ### Documentation Completeness
224
+ - [x] [PROJECT_INDEX.md](./PROJECT_INDEX.md) exists and maps all docs
225
+ - [x] [BACKLOG.md](../planning/BACKLOG.md) is self-contained with full descriptions
226
+ - [x] [BACKLOG.md](../planning/BACKLOG.md) has documentation/marketing section
227
+ - [x] [BACKLOG.md](../planning/BACKLOG.md) has CHANGELOG synchronization process
228
+ - [x] [CHANGELOG.md](../../CHANGELOG.md) has complete v1.4.0 section
229
+ - [x] All cross-references are valid
230
+
231
+ ### Process Clarity
232
+ - [x] Clear onboarding path (INDEX β†’ BACKLOG β†’ work)
233
+ - [x] Clear feature workflow (plan β†’ dev β†’ complete β†’ release)
234
+ - [x] Clear documentation workflow (tech docs β†’ user docs β†’ marketing)
235
+ - [x] Clear maintenance schedule (weekly/release/quarterly)
236
+
237
+ ### AI Handoff Readiness
238
+ - [x] Can onboard in < 30 min
239
+ - [x] All context needed is documented
240
+ - [x] No implicit knowledge required
241
+ - [x] Clear decision trees for common scenarios
242
+
243
+ ---
244
+
245
+ ## 🎯 Success Criteria
246
+
247
+ **This documentation system succeeds if:**
248
+
249
+ 1. βœ… **New AI can start working in 30 minutes** (onboarding speed)
250
+ 2. βœ… **All features have clear descriptions in [BACKLOG.md](../planning/BACKLOG.md)** (self-contained)
251
+ 3. βœ… **[CHANGELOG.md](../../CHANGELOG.md) ← β†’ [BACKLOG.md](../planning/BACKLOG.md) stay synchronized** (no drift)
252
+ 4. βœ… **Cross-references are always valid** (no broken links)
253
+ 5. βœ… **Marketing materials can be created from [BACKLOG.md](../planning/BACKLOG.md)** (completeness)
254
+
255
+ **Current Status: 5/5 criteria met βœ…**
256
+
257
+ ---
258
+
259
+ ## πŸ“ Example: How It All Works Together
260
+
261
+ Let's trace a feature from idea to marketing:
262
+
263
+ ### Week 1: Planning
264
+ ```markdown
265
+ # BACKLOG.md
266
+ ### Natural Date Parsing
267
+ **Status:** NOT STARTED
268
+ **Priority:** HIGH
269
+ **Effort:** 2-3 days
270
+ **What:** Accept "tomorrow 10am" instead of ISO 8601
271
+ **Files:** Create src/utils/date-parser.ts
272
+ **Libraries:** chrono-node
273
+ ```
274
+
275
+ ### Week 2-3: Development
276
+ ```markdown
277
+ # BACKLOG.md
278
+ ### Natural Date Parsing
279
+ **Status:** IN PROGRESS
280
+ [same details]
281
+ ```
282
+
283
+ ### Week 4: Completion
284
+ ```markdown
285
+ # BACKLOG.md
286
+ ### Natural Date Parsing
287
+ **Status:** βœ… COMPLETED
288
+
289
+ # CHANGELOG.md
290
+ ## [Unreleased]
291
+ ### Added - Natural Date Parsing
292
+ - Accept "tomorrow 10am", "next Monday", "+2 days"
293
+ - Uses chrono-node for parsing
294
+ - Shows confirmation of parsed date
295
+
296
+ **Example:**
297
+ $ cakemail campaigns schedule 123 --date "tomorrow 10am"
298
+ Parsed "tomorrow 10am" as Oct 12, 2025 10:00 AM EDT
299
+ βœ“ Campaign scheduled
300
+ ```
301
+
302
+ ### Week 5: Release v1.5.0
303
+ ```markdown
304
+ # CHANGELOG.md
305
+ ## [1.5.0] - 2025-10-20
306
+ ### Added - Natural Date Parsing
307
+ [Full description from Unreleased]
308
+
309
+ # BACKLOG.md
310
+ [Remove or mark βœ… SHIPPED v1.5.0]
311
+ ```
312
+
313
+ ### Week 6: Marketing
314
+ Using BACKLOG.md marketing templates (lines 810-908):
315
+ - βœ… Blog post written (template provided)
316
+ - βœ… Social media posts (templates provided)
317
+ - βœ… User manual section (template provided)
318
+ - βœ… Video demo created (guideline provided)
319
+
320
+ ---
321
+
322
+ ## πŸš€ Next Steps
323
+
324
+ **You're all set!** The documentation system is:
325
+ - βœ… Complete
326
+ - βœ… Self-documenting
327
+ - βœ… AI-friendly
328
+ - βœ… Marketing-ready
329
+
330
+ **To use it:**
331
+ 1. Follow the weekly maintenance process
332
+ 2. Update BACKLOG.md as you work
333
+ 3. Sync to CHANGELOG.md when complete
334
+ 4. Create marketing per templates
335
+ 5. Review quarterly
336
+
337
+ **Questions?**
338
+ - Check [PROJECT_INDEX.md](./PROJECT_INDEX.md) first
339
+ - Look for similar examples in [CHANGELOG.md](../../CHANGELOG.md)
340
+ - Follow templates in [BACKLOG.md](../planning/BACKLOG.md)
341
+
342
+ ---
343
+
344
+ **Last Updated:** 2025-10-11
345
+ **Status:** βœ… System Complete and Verified
346
+
@@ -0,0 +1,365 @@
1
+ # Cakemail CLI - Project Index
2
+
3
+ **🎯 START HERE for project onboarding and context**
4
+
5
+ ---
6
+
7
+ ## πŸ“– Quick Orientation
8
+
9
+ **What is this?** Official CLI for the Cakemail email marketing platform
10
+ **Current Version:** 1.4.0
11
+ **Status:** Active development
12
+ **Language:** TypeScript
13
+ **Distribution:** npm, Homebrew
14
+
15
+ ---
16
+
17
+ ## πŸ—ΊοΈ Documentation Map
18
+
19
+ ### For New AI/Contributors (Read First)
20
+
21
+ 1. **[README.md](../../README.md)** - Project overview, installation, basic usage
22
+ 2. **[ARCHITECTURE.md](./ARCHITECTURE.md)** - Code structure, design patterns, technical decisions
23
+ 3. **[CHANGELOG.md](../../CHANGELOG.md)** - Version history, what's been built (PAST)
24
+ 4. **[BACKLOG.md](../planning/BACKLOG.md)** - What's planned next (FUTURE)
25
+
26
+ **Read these 4 files to understand the entire project.**
27
+
28
+ ---
29
+
30
+ ### Documentation Structure
31
+
32
+ ```
33
+ /docs/
34
+ β”œβ”€β”€ README.md # Documentation hub
35
+ β”œβ”€β”€ developer/ # ← YOU ARE HERE
36
+ β”‚ β”œβ”€β”€ PROJECT_INDEX.md # This file (start here!)
37
+ β”‚ β”œβ”€β”€ ARCHITECTURE.md # Code structure
38
+ β”‚ β”œβ”€β”€ CONTRIBUTING.md # How to contribute
39
+ β”‚ β”œβ”€β”€ AUTH.md # Auth reference
40
+ β”‚ └── DOCUMENTATION_SUMMARY.md # How docs work
41
+ β”œβ”€β”€ planning/
42
+ β”‚ β”œβ”€β”€ BACKLOG.md # What's next (SINGLE SOURCE OF TRUTH)
43
+ β”‚ β”œβ”€β”€ API_COVERAGE.md # API coverage tracker
44
+ β”‚ β”œβ”€β”€ UX_IMPLEMENTATION_PLAN.md # UX roadmap
45
+ β”‚ β”œβ”€β”€ cakemail-profile-system-plan.md
46
+ β”‚ β”œβ”€β”€ PROFILE_SYSTEM_TASKS.md
47
+ β”‚ └── archive/ # Historical docs
48
+ └── user-manual/ # End-user documentation
49
+ ```
50
+
51
+ ---
52
+
53
+ ### Planning & Roadmap Documents
54
+
55
+ These documents inform BACKLOG.md:
56
+
57
+ | Document | Purpose | Status | Should Read? |
58
+ |----------|---------|--------|--------------|
59
+ | **[BACKLOG.md](../planning/BACKLOG.md)** | Master task list - SINGLE SOURCE OF TRUTH | βœ… Active | **YES - Start here for "what's next"** |
60
+ | [API_COVERAGE.md](../planning/API_COVERAGE.md) | API command coverage tracker | βœ… Active | YES - for API feature work |
61
+ | [UX_IMPLEMENTATION_PLAN.md](../planning/UX_IMPLEMENTATION_PLAN.md) | Detailed UX roadmap (v1.4-v1.7) | βœ… Active | YES - for UX feature work |
62
+ | [cakemail-profile-system-plan.md](../planning/cakemail-profile-system-plan.md) | Profile system design doc | βœ… Active | YES - if working on profiles |
63
+ | [PROFILE_SYSTEM_TASKS.md](../planning/PROFILE_SYSTEM_TASKS.md) | Profile system task breakdown | βœ… Active | YES - if implementing profiles |
64
+
65
+ ---
66
+
67
+ ### Reference Documents
68
+
69
+ | Document | Purpose | Should Read? |
70
+ |----------|---------|--------------|
71
+ | [CONTRIBUTING.md](./CONTRIBUTING.md) | Contribution guidelines | If contributing |
72
+ | [AUTH.md](./AUTH.md) | Authentication design | If working on auth |
73
+ | [DOCUMENTATION_SUMMARY.md](./DOCUMENTATION_SUMMARY.md) | How docs work together | If confused about docs |
74
+
75
+ ---
76
+
77
+ ### Historical Documents (Archive)
78
+
79
+ | Document | Purpose | Status |
80
+ |----------|---------|--------|
81
+ | [RELEASE_v1.3.0.md](../planning/archive/RELEASE_v1.3.0.md) | v1.3.0 release notes | βœ… Shipped |
82
+ | [RELEASE_CHECKLIST_v1.3.0.md](../planning/archive/RELEASE_CHECKLIST_v1.3.0.md) | v1.3.0 checklist | βœ… Complete |
83
+ | [cakemail-cli-ux-improvements.md](../planning/archive/cakemail-cli-ux-improvements.md) | Early UX brainstorming | Superseded |
84
+
85
+ **Note:** These are historical. Check [CHANGELOG.md](../../CHANGELOG.md) for complete version history.
86
+
87
+ ---
88
+
89
+ ## πŸ”„ Relationship Between Key Documents
90
+
91
+ ```
92
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
93
+ β”‚ README.md β”‚
94
+ β”‚ "What is this project? How do I use it?" β”‚
95
+ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
96
+ ↓
97
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
98
+ β”‚ ARCHITECTURE.md β”‚
99
+ β”‚ "How is the code organized? Why?" β”‚
100
+ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
101
+ ↓
102
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
103
+ β”‚ CHANGELOG.md ← β†’ BACKLOG.md β”‚
104
+ β”‚ PAST ← β†’ FUTURE β”‚
105
+ β”‚ "What we built" "What we're building next" β”‚
106
+ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
107
+ ↓
108
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
109
+ β”‚ β”‚ β”‚ β”‚
110
+ ↓ ↓ ↓ ↓
111
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
112
+ β”‚API_COVERAGE β”‚ β”‚ UX_IMPLEMENTATION β”‚ β”‚ PROFILE_SYSTEM β”‚ β”‚ AUTH.md β”‚
113
+ β”‚ .md β”‚ β”‚ _PLAN.md β”‚ β”‚ _PLAN.md β”‚ β”‚ β”‚
114
+ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚
115
+ β”‚ "API work" β”‚ β”‚ "UX work" β”‚ β”‚ "Profile work" β”‚ β”‚ "Auth ref" β”‚
116
+ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
117
+ ↓
118
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
119
+ β”‚ PROFILE_SYSTEM_TASKS β”‚
120
+ β”‚ .md β”‚
121
+ β”‚ β”‚
122
+ β”‚ "Detailed tasks" β”‚
123
+ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
124
+ ```
125
+
126
+ ---
127
+
128
+ ## 🎯 "What Should I Work On?" Decision Tree
129
+
130
+ ```
131
+ START HERE β†’ Read BACKLOG.md
132
+ ↓
133
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
134
+ ↓ ↓
135
+ Need context? Ready to code?
136
+ ↓ ↓
137
+ Read these: Check status:
138
+ - ARCHITECTURE - BACKLOG.md shows priority
139
+ - CHANGELOG - Find πŸ”΄ CRITICAL or 🟑 HIGH items
140
+ - Relevant plan - Pick a task
141
+ ↓ ↓
142
+ Pick work type: Read detailed plan:
143
+ ↓ ↓
144
+ β”Œβ”€β”€β”€β”΄β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”
145
+ ↓ ↓ ↓ ↓
146
+ API work UX work Profile Other
147
+ ↓ ↓ ↓ ↓
148
+ Read: Read: Read: Read:
149
+ API_ UX_ PROFILE_ CONTRIB
150
+ COVERAGE IMPL SYSTEM_ UTING.md
151
+ .md _PLAN PLAN.md
152
+ .md +TASKS.md
153
+ ```
154
+
155
+ ---
156
+
157
+ ## πŸ“ Document Lifecycle & Maintenance
158
+
159
+ ### CHANGELOG.md ← β†’ BACKLOG.md Synchronization
160
+
161
+ **The Rule:**
162
+ - **CHANGELOG.md** = Past (what shipped)
163
+ - **BACKLOG.md** = Future (what's planned)
164
+ - When something ships β†’ Move from BACKLOG β†’ CHANGELOG
165
+
166
+ **Process:**
167
+
168
+ 1. **Planning Phase** (now)
169
+ - Feature is in BACKLOG.md with status: NOT STARTED
170
+ - CHANGELOG.md doesn't mention it yet
171
+
172
+ 2. **Development Phase**
173
+ - Feature in BACKLOG.md status: IN PROGRESS
174
+ - Still not in CHANGELOG.md
175
+
176
+ 3. **Completion Phase**
177
+ - Feature in BACKLOG.md status: βœ… COMPLETED
178
+ - Add to CHANGELOG.md under "Unreleased" section
179
+
180
+ 4. **Release Phase**
181
+ - Remove from BACKLOG.md (or mark βœ… DONE)
182
+ - Move CHANGELOG.md "Unreleased" β†’ versioned section (e.g., [1.5.0])
183
+
184
+ **Example Flow:**
185
+
186
+ ```markdown
187
+ # BACKLOG.md (Week 1)
188
+ ### Natural Date Parsing
189
+ **Status:** NOT STARTED
190
+ **Priority:** HIGH
191
+
192
+ # BACKLOG.md (Week 2)
193
+ ### Natural Date Parsing
194
+ **Status:** IN PROGRESS
195
+ **Priority:** HIGH
196
+
197
+ # BACKLOG.md (Week 3)
198
+ ### Natural Date Parsing
199
+ **Status:** βœ… COMPLETED
200
+ **Priority:** HIGH
201
+
202
+ # CHANGELOG.md (Week 3)
203
+ ## [Unreleased]
204
+ ### Added
205
+ - Natural date parsing with chrono-node
206
+
207
+ # BACKLOG.md (Week 4 - after release)
208
+ ### Natural Date Parsing
209
+ **Status:** βœ… SHIPPED (v1.5.0)
210
+ [Can be removed from BACKLOG now]
211
+
212
+ # CHANGELOG.md (Week 4 - after release)
213
+ ## [1.5.0] - 2025-10-20
214
+ ### Added
215
+ - Natural date parsing with chrono-node
216
+ ```
217
+
218
+ ---
219
+
220
+ ## πŸ” Finding Information Fast
221
+
222
+ ### "How do I...?"
223
+
224
+ | Question | Answer |
225
+ |----------|--------|
226
+ | ...understand what this project does? | [README.md](../../README.md) |
227
+ | ...understand the codebase structure? | [ARCHITECTURE.md](./ARCHITECTURE.md) |
228
+ | ...see what's been built? | [CHANGELOG.md](../../CHANGELOG.md) |
229
+ | ...see what's planned? | [BACKLOG.md](../planning/BACKLOG.md) |
230
+ | ...know what to work on next? | [BACKLOG.md](../planning/BACKLOG.md) β†’ Priority Matrix |
231
+ | ...understand a specific feature plan? | [UX_IMPLEMENTATION_PLAN.md](../planning/UX_IMPLEMENTATION_PLAN.md) or [API_COVERAGE.md](../planning/API_COVERAGE.md) or [PROFILE_SYSTEM_PLAN.md](../planning/cakemail-profile-system-plan.md) |
232
+ | ...implement a feature? | [ARCHITECTURE.md](./ARCHITECTURE.md) + feature plan + existing code |
233
+ | ...test changes? | [CONTRIBUTING.md](./CONTRIBUTING.md) |
234
+ | ...release a version? | [CONTRIBUTING.md](./CONTRIBUTING.md) + [CHANGELOG.md](../../CHANGELOG.md) |
235
+
236
+ ---
237
+
238
+ ## πŸ€– AI Onboarding Checklist
239
+
240
+ If you're an AI assistant continuing work on this project:
241
+
242
+ ### Phase 1: Context Gathering (10 min)
243
+ - [ ] Read [PROJECT_INDEX.md](./PROJECT_INDEX.md) (this file) - 2 min
244
+ - [ ] Skim [README.md](../../README.md) - 2 min
245
+ - [ ] Skim [ARCHITECTURE.md](./ARCHITECTURE.md) - 3 min
246
+ - [ ] Read [CHANGELOG.md](../../CHANGELOG.md) v1.4.0 section - 2 min
247
+ - [ ] Scan [BACKLOG.md](../planning/BACKLOG.md) priority matrix - 1 min
248
+
249
+ **You now have 80% of context needed.**
250
+
251
+ ### Phase 2: Task Selection (5 min)
252
+ - [ ] Read [BACKLOG.md](../planning/BACKLOG.md) in detail - 3 min
253
+ - [ ] Identify current focus area from user
254
+ - [ ] Read relevant detailed plan ([API_COVERAGE.md](../planning/API_COVERAGE.md) or [UX_IMPLEMENTATION_PLAN.md](../planning/UX_IMPLEMENTATION_PLAN.md) or [PROFILE_SYSTEM_PLAN.md](../planning/cakemail-profile-system-plan.md)) - 2 min
255
+
256
+ **You now know what to work on.**
257
+
258
+ ### Phase 3: Implementation (varies)
259
+ - [ ] Review existing similar commands in src/commands/
260
+ - [ ] Check [ARCHITECTURE.md](./ARCHITECTURE.md) for patterns
261
+ - [ ] Implement following existing conventions
262
+ - [ ] Update [BACKLOG.md](../planning/BACKLOG.md) status (NOT STARTED β†’ IN PROGRESS)
263
+
264
+ ### Phase 4: Completion
265
+ - [ ] Update [BACKLOG.md](../planning/BACKLOG.md) (IN PROGRESS β†’ βœ… COMPLETED)
266
+ - [ ] Add to [CHANGELOG.md](../../CHANGELOG.md) under [Unreleased]
267
+ - [ ] Verify with npm run build
268
+
269
+ ---
270
+
271
+ ## πŸ“Š Current Project State (as of 2025-10-11)
272
+
273
+ **Version:** 1.4.0
274
+ **Commands:** 108 / 232 (46% API coverage)
275
+
276
+ **Recently Completed:**
277
+ - βœ… Enhanced output formatting (JSON highlighting, status badges, pagination)
278
+ - βœ… Smart defaults (auto-detect resources)
279
+ - βœ… Interactive confirmations (delete operations)
280
+ - βœ… Multi-tenant account support
281
+ - βœ… Progress indicators
282
+
283
+ **Current Focus:**
284
+ - Deciding between: API coverage expansion vs Profile system vs UX quick wins
285
+
286
+ **See [BACKLOG.md](../planning/BACKLOG.md) for complete status and next steps.**
287
+
288
+ ---
289
+
290
+ ## πŸš€ Quick Start for Contributors
291
+
292
+ ### 1. Setup
293
+ ```bash
294
+ git clone <repo>
295
+ cd cakemail-cli
296
+ npm install
297
+ npm run build
298
+ ```
299
+
300
+ ### 2. Understand codebase
301
+ ```bash
302
+ # Read these 4 files:
303
+ cat README.md
304
+ cat docs/developer/ARCHITECTURE.md
305
+ cat CHANGELOG.md | head -100
306
+ cat docs/planning/BACKLOG.md | head -100
307
+ ```
308
+
309
+ ### 3. Pick a task
310
+ ```bash
311
+ grep "NOT STARTED" docs/planning/BACKLOG.md
312
+ # Pick one, read relevant plan document
313
+ ```
314
+
315
+ ### 4. Implement
316
+ ```bash
317
+ # Follow patterns in src/commands/
318
+ # Update docs/planning/BACKLOG.md status
319
+ # Add to CHANGELOG.md
320
+ ```
321
+
322
+ ### 5. Test & Submit
323
+ ```bash
324
+ npm run build
325
+ # Manual testing
326
+ # Git commit & push
327
+ ```
328
+
329
+ ---
330
+
331
+ ## πŸ”§ Maintenance Tasks
332
+
333
+ ### Weekly
334
+ - [ ] Review [BACKLOG.md](../planning/BACKLOG.md) priorities
335
+ - [ ] Update task statuses
336
+ - [ ] Move completed items to [CHANGELOG.md](../../CHANGELOG.md)
337
+
338
+ ### Before Each Release
339
+ - [ ] Verify [CHANGELOG.md](../../CHANGELOG.md) is complete
340
+ - [ ] Archive completed BACKLOG items
341
+ - [ ] Update version numbers
342
+ - [ ] Update [PROJECT_INDEX.md](./PROJECT_INDEX.md) current state
343
+
344
+ ### Quarterly
345
+ - [ ] Review all documentation for accuracy
346
+ - [ ] Archive outdated planning docs
347
+ - [ ] Update priority matrix in [BACKLOG.md](../planning/BACKLOG.md)
348
+ - [ ] Clean up duplicate/obsolete docs
349
+
350
+ ---
351
+
352
+ ## πŸ“ž Questions?
353
+
354
+ - **For users:** See [README.md](../../README.md)
355
+ - **For contributors:** See [CONTRIBUTING.md](./CONTRIBUTING.md)
356
+ - **For architecture:** See [ARCHITECTURE.md](./ARCHITECTURE.md)
357
+ - **For roadmap:** See [BACKLOG.md](../planning/BACKLOG.md)
358
+ - **For anything else:** Check this index first
359
+
360
+ ---
361
+
362
+ **Last Updated:** 2025-10-11
363
+ **Maintained By:** FranΓ§ois Lane
364
+ **Next Review:** When v1.4.0 decisions are finalized
365
+