ai-flow-dev 1.0.3 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -35
- package/dist/cli.js +201 -232
- package/dist/cli.js.map +1 -1
- package/dist/fs-utils.js +3 -39
- package/dist/fs-utils.js.map +1 -1
- package/package.json +11 -12
- package/prompts/backend/{flow-docs-gen-phase-7.md → flow-bootstrap-phase-7.md} +41 -108
- package/prompts/backend/flow-bootstrap-phase-8.md +911 -0
- package/prompts/backend/{flow-project-roadmap.md → flow-bootstrap-phase-9.md} +255 -344
- package/prompts/backend/{flow-docs-gen.md → flow-bootstrap.md} +102 -37
- package/prompts/frontend/{flow-docs-gen-phase-0.md → flow-bootstrap-phase-0.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-1.md → flow-bootstrap-phase-1.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-3.md → flow-bootstrap-phase-3.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-4.md → flow-bootstrap-phase-4.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-5.md → flow-bootstrap-phase-5.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-6.md → flow-bootstrap-phase-6.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-7.md → flow-bootstrap-phase-7.md} +225 -200
- package/prompts/frontend/flow-bootstrap-phase-8.md +670 -0
- package/prompts/frontend/{flow-docs-gen.md → flow-bootstrap.md} +47 -20
- package/prompts/frontend/flow-docs-sync.md +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-0.md → flow-bootstrap-phase-0.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-1.md → flow-bootstrap-phase-1.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-2.md → flow-bootstrap-phase-2.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-3.md → flow-bootstrap-phase-3.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-4.md → flow-bootstrap-phase-4.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-5.md → flow-bootstrap-phase-5.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-6.md → flow-bootstrap-phase-6.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-7.md → flow-bootstrap-phase-7.md} +174 -132
- package/prompts/mobile/flow-bootstrap-phase-8.md +676 -0
- package/prompts/mobile/{flow-docs-gen.md → flow-bootstrap.md} +47 -20
- package/prompts/mobile/flow-docs-sync.md +2 -1
- package/prompts/backend/flow-project-init.md +0 -332
- /package/prompts/backend/{flow-docs-gen-phase-0.md → flow-bootstrap-phase-0.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-1.md → flow-bootstrap-phase-1.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-2.md → flow-bootstrap-phase-2.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-3.md → flow-bootstrap-phase-3.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-4.md → flow-bootstrap-phase-4.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-5.md → flow-bootstrap-phase-5.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-6.md → flow-bootstrap-phase-6.md} +0 -0
- /package/prompts/frontend/{flow-docs-gen-phase-2.md → flow-bootstrap-phase-2.md} +0 -0
|
@@ -0,0 +1,911 @@
|
|
|
1
|
+
# 🏆 Phase 8: Project Setup & Final Documentation
|
|
2
|
+
|
|
3
|
+
**Context:** Phases 1-7 have collected all project information. Now we'll initialize the framework (if needed) and generate all final documentation.
|
|
4
|
+
|
|
5
|
+
**Duration:** 10-15 minutes
|
|
6
|
+
|
|
7
|
+
**Goal:** Set up the project structure and create comprehensive documentation that consolidates all information from previous phases.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 📋 Phase 8 Overview
|
|
12
|
+
|
|
13
|
+
This final phase will:
|
|
14
|
+
|
|
15
|
+
1. **Detect project state** (new vs existing project)
|
|
16
|
+
2. **Initialize framework** (optional, for new projects)
|
|
17
|
+
3. **Generate final documentation** (business-flows, api, contributing)
|
|
18
|
+
4. **Generate master index** (AGENT.md)
|
|
19
|
+
5. **Generate README.md** (with intelligent merge if needed)
|
|
20
|
+
6. **Create tool-specific configs** (based on AI tool selection)
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 8.1: Project State Detection
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
🔍 Detecting current project state...
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
**Auto-detect:**
|
|
31
|
+
|
|
32
|
+
- [ ] Check for existing source code (`src/`, `app/`, `lib/`, etc.)
|
|
33
|
+
- [ ] Check for framework files (`nest-cli.json`, `manage.py`, `go.mod`, etc.)
|
|
34
|
+
- [ ] Check for package managers (`package.json`, `requirements.txt`, `go.mod`, etc.)
|
|
35
|
+
- [ ] Check for existing README.md (framework-generated or custom)
|
|
36
|
+
|
|
37
|
+
**Classification:**
|
|
38
|
+
|
|
39
|
+
- **New Project**: No source code, no framework files
|
|
40
|
+
- **Initialized Framework**: Has framework files, has source code
|
|
41
|
+
- **Existing Project**: Has source code but AI Flow docs were just created
|
|
42
|
+
|
|
43
|
+
**Present Detection Results:**
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
📊 Project State Detection:
|
|
47
|
+
|
|
48
|
+
Type: [New Project | Initialized Framework | Existing Project]
|
|
49
|
+
|
|
50
|
+
Found:
|
|
51
|
+
- Source directories: [list or none]
|
|
52
|
+
- Framework files: [list or none]
|
|
53
|
+
- Package manager: [npm/pip/go/etc. or none]
|
|
54
|
+
- README.md: [exists: yes/no]
|
|
55
|
+
|
|
56
|
+
Recommendation: [Next action based on state]
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 8.2: Framework Initialization (Optional)
|
|
62
|
+
|
|
63
|
+
**Only if:** Project state = "New Project"
|
|
64
|
+
|
|
65
|
+
### 8.2.1: Ask User Preference
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
🎯 Your project appears to be new.
|
|
69
|
+
|
|
70
|
+
Would you like me to initialize the [FRAMEWORK_NAME] project structure now?
|
|
71
|
+
|
|
72
|
+
Options:
|
|
73
|
+
A) ✅ Yes, initialize [FRAMEWORK_NAME] (recommended)
|
|
74
|
+
B) ⏭️ Skip for now (manual setup later)
|
|
75
|
+
|
|
76
|
+
→ Your choice:
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**If user chooses A (initialize):**
|
|
80
|
+
|
|
81
|
+
### 8.2.2: Pre-initialization Backup
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
📦 Preparing for framework initialization...
|
|
85
|
+
|
|
86
|
+
Creating backup of AI Flow documentation:
|
|
87
|
+
→ Moving .ai-flow/ docs to .ai-flow/temp-backup/
|
|
88
|
+
|
|
89
|
+
Files to backup:
|
|
90
|
+
✅ project-brief.md
|
|
91
|
+
✅ docs/data-model.md
|
|
92
|
+
✅ docs/architecture.md
|
|
93
|
+
✅ ai-instructions.md
|
|
94
|
+
✅ specs/security.md
|
|
95
|
+
✅ docs/code-standards.md
|
|
96
|
+
✅ docs/testing.md
|
|
97
|
+
✅ docs/operations.md
|
|
98
|
+
✅ specs/configuration.md
|
|
99
|
+
✅ .env.example
|
|
100
|
+
|
|
101
|
+
Backup complete! Safe to initialize framework.
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 8.2.3: Execute Framework CLI
|
|
105
|
+
|
|
106
|
+
**Based on framework detected in Phase 3:**
|
|
107
|
+
|
|
108
|
+
**Node.js frameworks:**
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
# NestJS
|
|
112
|
+
npx @nestjs/cli new . --skip-git --package-manager npm
|
|
113
|
+
|
|
114
|
+
# Express (using express-generator)
|
|
115
|
+
npx express-generator . --no-view --git
|
|
116
|
+
|
|
117
|
+
# Fastify
|
|
118
|
+
npm init fastify
|
|
119
|
+
|
|
120
|
+
# Next.js
|
|
121
|
+
npx create-next-app@latest . --typescript --eslint --tailwind --app --src-dir --import-alias "@/*"
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**Python frameworks:**
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
# Django
|
|
128
|
+
django-admin startproject config .
|
|
129
|
+
|
|
130
|
+
# FastAPI
|
|
131
|
+
# Create main.py, requirements.txt, project structure
|
|
132
|
+
mkdir -p app/api app/models app/schemas app/services
|
|
133
|
+
touch main.py requirements.txt
|
|
134
|
+
# Generate starter files
|
|
135
|
+
|
|
136
|
+
# Flask
|
|
137
|
+
flask init
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
**Other frameworks:**
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
# Go
|
|
144
|
+
go mod init [module-name]
|
|
145
|
+
|
|
146
|
+
# .NET
|
|
147
|
+
dotnet new webapi -n [ProjectName]
|
|
148
|
+
|
|
149
|
+
# Ruby on Rails
|
|
150
|
+
rails new . --api --skip-git
|
|
151
|
+
|
|
152
|
+
# PHP Laravel
|
|
153
|
+
composer create-project laravel/laravel .
|
|
154
|
+
|
|
155
|
+
# Java Spring Boot
|
|
156
|
+
spring init --dependencies=web,data-jpa --build=maven .
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
**Show progress:**
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
🚀 Initializing [FRAMEWORK_NAME]...
|
|
163
|
+
|
|
164
|
+
[Framework CLI output]
|
|
165
|
+
|
|
166
|
+
✅ Framework initialized successfully!
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### 8.2.4: Restore AI Flow Documentation
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
📥 Restoring AI Flow documentation...
|
|
173
|
+
|
|
174
|
+
Moving files from .ai-flow/temp-backup/ back to .ai-flow/
|
|
175
|
+
|
|
176
|
+
✅ All AI Flow docs restored!
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### 8.2.5: Handle README.md Conflict
|
|
180
|
+
|
|
181
|
+
**If framework created README.md:**
|
|
182
|
+
|
|
183
|
+
```
|
|
184
|
+
⚠️ Framework generated its own README.md
|
|
185
|
+
|
|
186
|
+
I'll merge it with AI Flow's comprehensive README:
|
|
187
|
+
|
|
188
|
+
Strategy:
|
|
189
|
+
1. Keep framework's quick start section (if valuable)
|
|
190
|
+
2. Replace with AI Flow's comprehensive content
|
|
191
|
+
3. Preserve any framework-specific setup instructions
|
|
192
|
+
|
|
193
|
+
Merging...
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
**Merge Logic:**
|
|
197
|
+
|
|
198
|
+
- Extract framework's "Getting Started" or "Installation" section (usually first 50-100 lines)
|
|
199
|
+
- Use AI Flow's README template as base
|
|
200
|
+
- Insert framework's quick start in appropriate section
|
|
201
|
+
- Ensure no duplication
|
|
202
|
+
- Keep AI Flow's structure (overview, features, tech stack, etc.)
|
|
203
|
+
|
|
204
|
+
**If user chooses B (skip):**
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
⏭️ Skipping framework initialization.
|
|
208
|
+
|
|
209
|
+
You can initialize manually later with:
|
|
210
|
+
[Show appropriate CLI command]
|
|
211
|
+
|
|
212
|
+
Proceeding to documentation generation...
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## 8.3: Generate Final Documentation
|
|
218
|
+
|
|
219
|
+
```
|
|
220
|
+
📖 Re-reading all generated documents to ensure accuracy...
|
|
221
|
+
|
|
222
|
+
✅ Re-reading project-brief.md
|
|
223
|
+
✅ Re-reading docs/data-model.md
|
|
224
|
+
✅ Re-reading docs/architecture.md
|
|
225
|
+
✅ Re-reading ai-instructions.md
|
|
226
|
+
✅ Re-reading specs/security.md
|
|
227
|
+
✅ Re-reading docs/code-standards.md
|
|
228
|
+
✅ Re-reading docs/testing.md
|
|
229
|
+
✅ Re-reading docs/operations.md
|
|
230
|
+
✅ Re-reading specs/configuration.md
|
|
231
|
+
✅ Re-reading .env.example
|
|
232
|
+
|
|
233
|
+
✅ Context fully loaded and updated!
|
|
234
|
+
|
|
235
|
+
🎉 Now generating final 5 documents:
|
|
236
|
+
|
|
237
|
+
1. docs/business-flows.md - Business process flows and mermaid diagrams
|
|
238
|
+
2. docs/api.md - API endpoints and conventions reference
|
|
239
|
+
3. docs/contributing.md - Contribution guidelines
|
|
240
|
+
4. README.md - Project overview (consolidates all phases)
|
|
241
|
+
5. AGENT.md - Universal AI configuration (master index)
|
|
242
|
+
|
|
243
|
+
Generating...
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### 8.3.1: Generate docs/business-flows.md
|
|
247
|
+
|
|
248
|
+
- **Template:** `.ai-flow/templates/docs/business-flows.template.md`
|
|
249
|
+
- **Content from:** Phase 1 (questions 1.3, 1.4, 1.5)
|
|
250
|
+
- **Requirements:**
|
|
251
|
+
- List all business flows from Phase 1
|
|
252
|
+
- Generate mermaid sequence/flow diagram for EACH flow
|
|
253
|
+
- Include actors, steps, decision points
|
|
254
|
+
- Add error handling scenarios
|
|
255
|
+
- Link to relevant entities from data-model.md
|
|
256
|
+
|
|
257
|
+
**Example format:**
|
|
258
|
+
|
|
259
|
+
```markdown
|
|
260
|
+
## User Registration Flow
|
|
261
|
+
|
|
262
|
+
**Actors:** User, System, Email Service
|
|
263
|
+
|
|
264
|
+
**Steps:**
|
|
265
|
+
|
|
266
|
+
1. User submits registration form
|
|
267
|
+
2. System validates input
|
|
268
|
+
3. System creates user account
|
|
269
|
+
4. System sends verification email
|
|
270
|
+
5. User clicks verification link
|
|
271
|
+
6. System activates account
|
|
272
|
+
|
|
273
|
+
**Mermaid Diagram:**
|
|
274
|
+
|
|
275
|
+
[Generate mermaid sequence diagram]
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
### 8.3.2: Generate docs/api.md
|
|
279
|
+
|
|
280
|
+
- **Template:** `.ai-flow/templates/docs/api.template.md`
|
|
281
|
+
- **Content from:** Phase 2 (entities) + Phase 3 (question 3.5 - API conventions)
|
|
282
|
+
- **Requirements:**
|
|
283
|
+
- Auto-generate CRUD endpoints for each entity from data-model.md
|
|
284
|
+
- Apply REST/GraphQL conventions from Phase 3
|
|
285
|
+
- Include authentication requirements
|
|
286
|
+
- Document pagination format
|
|
287
|
+
- Document error response format
|
|
288
|
+
- Include example requests/responses
|
|
289
|
+
|
|
290
|
+
**Example format:**
|
|
291
|
+
|
|
292
|
+
````markdown
|
|
293
|
+
## Users API
|
|
294
|
+
|
|
295
|
+
### List Users
|
|
296
|
+
|
|
297
|
+
`GET /api/users`
|
|
298
|
+
|
|
299
|
+
**Authentication:** Required (Bearer token)
|
|
300
|
+
|
|
301
|
+
**Query Parameters:**
|
|
302
|
+
|
|
303
|
+
- `page` (number): Page number (default: 1)
|
|
304
|
+
- `limit` (number): Items per page (default: 20)
|
|
305
|
+
- `sort` (string): Sort field (default: createdAt)
|
|
306
|
+
|
|
307
|
+
**Response:**
|
|
308
|
+
|
|
309
|
+
```json
|
|
310
|
+
{
|
|
311
|
+
"data": [...],
|
|
312
|
+
"meta": {
|
|
313
|
+
"page": 1,
|
|
314
|
+
"limit": 20,
|
|
315
|
+
"total": 150
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
```
|
|
319
|
+
````
|
|
320
|
+
|
|
321
|
+
````
|
|
322
|
+
|
|
323
|
+
### 8.3.3: Generate docs/contributing.md
|
|
324
|
+
|
|
325
|
+
- **Template:** `.ai-flow/templates/docs/contributing.template.md`
|
|
326
|
+
- **Content from:** Phase 5 (questions 5.1-5.5) + Phase 7 (setup)
|
|
327
|
+
- **Requirements:**
|
|
328
|
+
- Git workflow from Phase 5
|
|
329
|
+
- Commit message format from Phase 5
|
|
330
|
+
- Code review process from Phase 5
|
|
331
|
+
- Setup instructions from Phase 3 & 7
|
|
332
|
+
- Testing requirements from Phase 6
|
|
333
|
+
|
|
334
|
+
**Example format:**
|
|
335
|
+
|
|
336
|
+
```markdown
|
|
337
|
+
## Getting Started
|
|
338
|
+
|
|
339
|
+
1. Clone repository
|
|
340
|
+
2. Install dependencies: `[command from Phase 7]`
|
|
341
|
+
3. Copy `.env.example` to `.env`
|
|
342
|
+
4. Run migrations: `[command from Phase 7]`
|
|
343
|
+
5. Start dev server: `[command from Phase 7]`
|
|
344
|
+
|
|
345
|
+
## Git Workflow
|
|
346
|
+
|
|
347
|
+
We use [workflow from Phase 5]
|
|
348
|
+
|
|
349
|
+
## Commit Format
|
|
350
|
+
|
|
351
|
+
[Format from Phase 5.2]
|
|
352
|
+
````
|
|
353
|
+
|
|
354
|
+
---
|
|
355
|
+
|
|
356
|
+
## 8.4: Generate AGENT.md (Master Index)
|
|
357
|
+
|
|
358
|
+
- **Template:** `.ai-flow/templates/AGENT.template.md`
|
|
359
|
+
- **Content from:** ALL phases (this is the aggregator)
|
|
360
|
+
- **Requirements:**
|
|
361
|
+
- **CRITICAL:** Re-read ALL 10 previously generated documents before filling
|
|
362
|
+
- List all 15 documents with descriptions
|
|
363
|
+
- Provide quick reference to tech stack
|
|
364
|
+
- Include critical architecture rules
|
|
365
|
+
- Link to all specs and docs
|
|
366
|
+
- Summarize key decisions from each phase
|
|
367
|
+
- Include common commands
|
|
368
|
+
|
|
369
|
+
**Structure:**
|
|
370
|
+
|
|
371
|
+
```markdown
|
|
372
|
+
# 🤖 AGENT.md - Universal AI Assistant Configuration
|
|
373
|
+
|
|
374
|
+
## 📚 Documentation Index
|
|
375
|
+
|
|
376
|
+
### Core Documents
|
|
377
|
+
|
|
378
|
+
1. **project-brief.md** - [1-sentence description]
|
|
379
|
+
2. **ai-instructions.md** - [1-sentence description]
|
|
380
|
+
|
|
381
|
+
### Specifications
|
|
382
|
+
|
|
383
|
+
3. **specs/security.md** - [1-sentence description]
|
|
384
|
+
4. **specs/configuration.md** - [1-sentence description]
|
|
385
|
+
|
|
386
|
+
### Documentation
|
|
387
|
+
|
|
388
|
+
5. **docs/data-model.md** - [1-sentence description]
|
|
389
|
+
6. **docs/architecture.md** - [1-sentence description]
|
|
390
|
+
7. **docs/business-flows.md** - [1-sentence description]
|
|
391
|
+
8. **docs/api.md** - [1-sentence description]
|
|
392
|
+
9. **docs/code-standards.md** - [1-sentence description]
|
|
393
|
+
10. **docs/testing.md** - [1-sentence description]
|
|
394
|
+
11. **docs/operations.md** - [1-sentence description]
|
|
395
|
+
12. **docs/contributing.md** - [1-sentence description]
|
|
396
|
+
|
|
397
|
+
### Quick Start
|
|
398
|
+
|
|
399
|
+
13. **.env.example** - Environment variables template
|
|
400
|
+
14. **README.md** - Project overview and setup
|
|
401
|
+
|
|
402
|
+
## 🎯 Quick Reference
|
|
403
|
+
|
|
404
|
+
### Tech Stack
|
|
405
|
+
|
|
406
|
+
[List from Phase 3]
|
|
407
|
+
|
|
408
|
+
### Critical Rules
|
|
409
|
+
|
|
410
|
+
[Key rules from code-standards.md and ai-instructions.md]
|
|
411
|
+
|
|
412
|
+
### Common Commands
|
|
413
|
+
|
|
414
|
+
[From operations.md and contributing.md]
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
---
|
|
418
|
+
|
|
419
|
+
## 8.5: Generate README.md (Intelligent Merge)
|
|
420
|
+
|
|
421
|
+
- **Template:** `.ai-flow/templates/README.template.md`
|
|
422
|
+
- **Content from:** ALL phases (most comprehensive document)
|
|
423
|
+
- **Requirements:**
|
|
424
|
+
- **CRITICAL:** Re-read ALL documents before generating
|
|
425
|
+
- Include project overview from Phase 1
|
|
426
|
+
- List features from Phase 1
|
|
427
|
+
- Show tech stack from Phase 3
|
|
428
|
+
- Include quick start from Phase 7
|
|
429
|
+
- Link to all documentation
|
|
430
|
+
- Include deployment info from Phase 7
|
|
431
|
+
- Add badges, license, contact info
|
|
432
|
+
|
|
433
|
+
**Merge Strategy (if framework README exists):**
|
|
434
|
+
|
|
435
|
+
1. **Read framework's README.md** (if exists from step 8.2)
|
|
436
|
+
2. **Extract valuable sections:**
|
|
437
|
+
- Installation commands specific to framework
|
|
438
|
+
- Framework-specific setup instructions
|
|
439
|
+
- Any auto-generated content that's useful
|
|
440
|
+
3. **Use AI Flow template as base structure:**
|
|
441
|
+
- Project name and description (from Phase 1)
|
|
442
|
+
- Features (from Phase 1)
|
|
443
|
+
- Tech stack (from Phase 3)
|
|
444
|
+
- Architecture overview (link to docs/architecture.md)
|
|
445
|
+
- Getting started (merge with framework's instructions)
|
|
446
|
+
- API documentation (link to docs/api.md)
|
|
447
|
+
- Testing (link to docs/testing.md)
|
|
448
|
+
- Deployment (from Phase 7)
|
|
449
|
+
- Contributing (link to docs/contributing.md)
|
|
450
|
+
- License
|
|
451
|
+
4. **Insert framework-specific content** in "Getting Started" section
|
|
452
|
+
5. **Ensure no duplication** between sections
|
|
453
|
+
6. **Validate all links** work correctly
|
|
454
|
+
|
|
455
|
+
**Example merged section:**
|
|
456
|
+
|
|
457
|
+
````markdown
|
|
458
|
+
## 🚀 Getting Started
|
|
459
|
+
|
|
460
|
+
### Prerequisites
|
|
461
|
+
|
|
462
|
+
- Node.js 18+ (from Phase 3)
|
|
463
|
+
- PostgreSQL 14+ (from Phase 3)
|
|
464
|
+
- Redis 6+ (from Phase 3)
|
|
465
|
+
|
|
466
|
+
### Installation
|
|
467
|
+
|
|
468
|
+
1. Clone the repository:
|
|
469
|
+
|
|
470
|
+
```bash
|
|
471
|
+
git clone [repo-url]
|
|
472
|
+
cd [project-name]
|
|
473
|
+
```
|
|
474
|
+
````
|
|
475
|
+
|
|
476
|
+
2. Install dependencies:
|
|
477
|
+
|
|
478
|
+
```bash
|
|
479
|
+
npm install # From framework
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
3. Set up environment variables:
|
|
483
|
+
|
|
484
|
+
```bash
|
|
485
|
+
cp .env.example .env
|
|
486
|
+
# Edit .env with your configuration (see specs/configuration.md)
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
4. Run database migrations:
|
|
490
|
+
|
|
491
|
+
```bash
|
|
492
|
+
npm run migration:run # From Phase 7
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
5. Start development server:
|
|
496
|
+
|
|
497
|
+
```bash
|
|
498
|
+
npm run start:dev # From framework
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
The API will be available at `http://localhost:3000`
|
|
502
|
+
|
|
503
|
+
````
|
|
504
|
+
|
|
505
|
+
**Success message:**
|
|
506
|
+
|
|
507
|
+
```
|
|
508
|
+
✅ README.md generated!
|
|
509
|
+
[If merged] Merged with framework's setup instructions
|
|
510
|
+
```
|
|
511
|
+
|
|
512
|
+
---
|
|
513
|
+
|
|
514
|
+
## 8.6: Create Tool-Specific Configs
|
|
515
|
+
|
|
516
|
+
**Based on AI tool selection from Phase 3 (question 3.8):**
|
|
517
|
+
|
|
518
|
+
### If Claude selected:
|
|
519
|
+
|
|
520
|
+
**Create `.clauderules`:**
|
|
521
|
+
|
|
522
|
+
```markdown
|
|
523
|
+
# Claude AI Configuration
|
|
524
|
+
|
|
525
|
+
This project uses AI Flow documentation structure.
|
|
526
|
+
|
|
527
|
+
## Primary Reference
|
|
528
|
+
|
|
529
|
+
Read `.ai-flow/AGENT.md` first for complete documentation index.
|
|
530
|
+
|
|
531
|
+
## Key Documents
|
|
532
|
+
|
|
533
|
+
- Project overview: `.ai-flow/project-brief.md`
|
|
534
|
+
- AI instructions: `.ai-flow/ai-instructions.md`
|
|
535
|
+
- Architecture: `.ai-flow/docs/architecture.md`
|
|
536
|
+
- API reference: `.ai-flow/docs/api.md`
|
|
537
|
+
- Code standards: `.ai-flow/docs/code-standards.md`
|
|
538
|
+
|
|
539
|
+
## Working Instructions
|
|
540
|
+
|
|
541
|
+
When writing code:
|
|
542
|
+
|
|
543
|
+
1. Follow patterns in `.ai-flow/docs/code-standards.md`
|
|
544
|
+
2. Reference data model in `.ai-flow/docs/data-model.md`
|
|
545
|
+
3. Implement security rules from `.ai-flow/specs/security.md`
|
|
546
|
+
4. Write tests per `.ai-flow/docs/testing.md`
|
|
547
|
+
|
|
548
|
+
## Critical Rules
|
|
549
|
+
|
|
550
|
+
[Extract top 5-10 rules from ai-instructions.md]
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
### If Cursor selected:
|
|
554
|
+
|
|
555
|
+
**Create `.cursorrules`:**
|
|
556
|
+
|
|
557
|
+
```markdown
|
|
558
|
+
# Cursor AI Configuration
|
|
559
|
+
|
|
560
|
+
Project uses AI Flow documentation in `.ai-flow/` directory.
|
|
561
|
+
|
|
562
|
+
## Documentation Index
|
|
563
|
+
|
|
564
|
+
See `.ai-flow/AGENT.md` for complete document list.
|
|
565
|
+
|
|
566
|
+
## Quick Reference
|
|
567
|
+
|
|
568
|
+
- Tech Stack: [from Phase 3]
|
|
569
|
+
- Architecture: `.ai-flow/docs/architecture.md`
|
|
570
|
+
- Code Standards: `.ai-flow/docs/code-standards.md`
|
|
571
|
+
- API Conventions: `.ai-flow/docs/api.md`
|
|
572
|
+
|
|
573
|
+
## Code Generation Rules
|
|
574
|
+
|
|
575
|
+
[Extract key rules from ai-instructions.md]
|
|
576
|
+
|
|
577
|
+
## Testing Requirements
|
|
578
|
+
|
|
579
|
+
[Extract from docs/testing.md]
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
### If GitHub Copilot selected:
|
|
583
|
+
|
|
584
|
+
**Create `.github/copilot-instructions.md`:**
|
|
585
|
+
|
|
586
|
+
```markdown
|
|
587
|
+
# GitHub Copilot Instructions
|
|
588
|
+
|
|
589
|
+
## Project Context
|
|
590
|
+
|
|
591
|
+
[Project description from Phase 1]
|
|
592
|
+
|
|
593
|
+
## Documentation Structure
|
|
594
|
+
|
|
595
|
+
This project uses AI Flow. All documentation is in `.ai-flow/` directory.
|
|
596
|
+
|
|
597
|
+
Master index: `.ai-flow/AGENT.md`
|
|
598
|
+
|
|
599
|
+
## Key References
|
|
600
|
+
|
|
601
|
+
- Architecture: `.ai-flow/docs/architecture.md`
|
|
602
|
+
- Data Model: `.ai-flow/docs/data-model.md`
|
|
603
|
+
- API: `.ai-flow/docs/api.md`
|
|
604
|
+
- Code Standards: `.ai-flow/docs/code-standards.md`
|
|
605
|
+
- Testing: `.ai-flow/docs/testing.md`
|
|
606
|
+
|
|
607
|
+
## Code Generation Guidelines
|
|
608
|
+
|
|
609
|
+
[Extract guidelines from ai-instructions.md and code-standards.md]
|
|
610
|
+
|
|
611
|
+
## Tech Stack
|
|
612
|
+
|
|
613
|
+
[From Phase 3]
|
|
614
|
+
|
|
615
|
+
## Common Patterns
|
|
616
|
+
|
|
617
|
+
[Extract from code-standards.md]
|
|
618
|
+
```
|
|
619
|
+
|
|
620
|
+
### If "All" selected:
|
|
621
|
+
|
|
622
|
+
Generate all three files above.
|
|
623
|
+
|
|
624
|
+
---
|
|
625
|
+
|
|
626
|
+
## 8.7: Final Validation & Success Message
|
|
627
|
+
|
|
628
|
+
```
|
|
629
|
+
🔍 Validating all generated files...
|
|
630
|
+
|
|
631
|
+
✅ Checking for placeholder text...
|
|
632
|
+
✅ Validating file references...
|
|
633
|
+
✅ Ensuring all links work...
|
|
634
|
+
✅ Verifying template completeness...
|
|
635
|
+
|
|
636
|
+
All validations passed!
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
**Show complete summary:**
|
|
640
|
+
|
|
641
|
+
```
|
|
642
|
+
🎉 AI Flow Complete!
|
|
643
|
+
|
|
644
|
+
Generated 15 documents successfully:
|
|
645
|
+
|
|
646
|
+
Phase 1:
|
|
647
|
+
✅ project-brief.md
|
|
648
|
+
|
|
649
|
+
Phase 2:
|
|
650
|
+
✅ docs/data-model.md
|
|
651
|
+
|
|
652
|
+
Phase 3:
|
|
653
|
+
✅ docs/architecture.md
|
|
654
|
+
✅ ai-instructions.md
|
|
655
|
+
|
|
656
|
+
Phase 4:
|
|
657
|
+
✅ specs/security.md
|
|
658
|
+
|
|
659
|
+
Phase 5:
|
|
660
|
+
✅ docs/code-standards.md
|
|
661
|
+
|
|
662
|
+
Phase 6:
|
|
663
|
+
✅ docs/testing.md
|
|
664
|
+
|
|
665
|
+
Phase 7:
|
|
666
|
+
✅ docs/operations.md
|
|
667
|
+
✅ specs/configuration.md
|
|
668
|
+
✅ .env.example
|
|
669
|
+
|
|
670
|
+
Phase 8:
|
|
671
|
+
✅ docs/business-flows.md
|
|
672
|
+
✅ docs/api.md
|
|
673
|
+
✅ docs/contributing.md
|
|
674
|
+
✅ README.md
|
|
675
|
+
✅ AGENT.md
|
|
676
|
+
|
|
677
|
+
[If framework initialized:]
|
|
678
|
+
✅ [FRAMEWORK_NAME] project initialized
|
|
679
|
+
|
|
680
|
+
[If README merged:]
|
|
681
|
+
✅ README.md merged with framework's setup instructions
|
|
682
|
+
|
|
683
|
+
Tool-specific configs:
|
|
684
|
+
✅ [List generated configs: .clauderules, .cursorrules, .github/copilot-instructions.md]
|
|
685
|
+
|
|
686
|
+
---
|
|
687
|
+
|
|
688
|
+
📁 Project Structure:
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
your-project/
|
|
692
|
+
├── .ai-flow/ # AI Flow documentation
|
|
693
|
+
│ ├── project-brief.md
|
|
694
|
+
│ ├── AGENT.md ⭐ Start here!
|
|
695
|
+
│ ├── ai-instructions.md
|
|
696
|
+
│ ├── docs/
|
|
697
|
+
│ │ ├── data-model.md
|
|
698
|
+
│ │ ├── architecture.md
|
|
699
|
+
│ │ ├── business-flows.md
|
|
700
|
+
│ │ ├── api.md
|
|
701
|
+
│ │ ├── code-standards.md
|
|
702
|
+
│ │ ├── testing.md
|
|
703
|
+
│ │ ├── operations.md
|
|
704
|
+
│ │ └── contributing.md
|
|
705
|
+
│ ├── specs/
|
|
706
|
+
│ │ ├── security.md
|
|
707
|
+
│ │ └── configuration.md
|
|
708
|
+
│ └── templates/ # Original templates
|
|
709
|
+
├── [framework files] # If initialized
|
|
710
|
+
├── README.md
|
|
711
|
+
├── .env.example
|
|
712
|
+
└── [tool configs] # .clauderules, .cursorrules, etc.
|
|
713
|
+
|
|
714
|
+
````
|
|
715
|
+
|
|
716
|
+
---
|
|
717
|
+
|
|
718
|
+
Next steps:
|
|
719
|
+
|
|
720
|
+
1. ⭐ **Read `.ai-flow/AGENT.md`** - Master index of all documentation
|
|
721
|
+
2. 📖 **Review generated documents** - Customize as needed
|
|
722
|
+
3. 🔧 **Set up environment** - Copy `.env.example` to `.env` and configure
|
|
723
|
+
[If NOT initialized:]
|
|
724
|
+
4. 🚀 **Initialize framework** - Run: `[show command from Phase 3]`
|
|
725
|
+
[If initialized:]
|
|
726
|
+
5. 🚀 **Install dependencies** - Run: `[show command from Phase 7]`
|
|
727
|
+
6. 💾 **Initialize git** (if not done) - `git init && git add . && git commit -m "Initial commit with AI Flow docs"`
|
|
728
|
+
7. 🧪 **Start building!** - Your AI assistant now has complete project context
|
|
729
|
+
|
|
730
|
+
---
|
|
731
|
+
|
|
732
|
+
💡 **Remember:**
|
|
733
|
+
|
|
734
|
+
- Documents are **living artifacts** - update them as project evolves
|
|
735
|
+
- All AI assistants will reference these docs for future work
|
|
736
|
+
- AGENT.md is the **single source of truth** for AI context
|
|
737
|
+
|
|
738
|
+
🤖 **AI Assistant Usage:**
|
|
739
|
+
Your AI assistant (Claude, Cursor, Copilot) will now:
|
|
740
|
+
|
|
741
|
+
- ✅ Understand complete project context
|
|
742
|
+
- ✅ Follow your architecture patterns
|
|
743
|
+
- ✅ Generate code matching your standards
|
|
744
|
+
- ✅ Reference your data model
|
|
745
|
+
- ✅ Apply your security rules
|
|
746
|
+
- ✅ Write tests per your guidelines
|
|
747
|
+
|
|
748
|
+
Happy building! 🎉
|
|
749
|
+
|
|
750
|
+
```
|
|
751
|
+
|
|
752
|
+
---
|
|
753
|
+
|
|
754
|
+
## EXECUTION CHECKLIST FOR AI ASSISTANT
|
|
755
|
+
|
|
756
|
+
When executing Phase 8:
|
|
757
|
+
|
|
758
|
+
**8.1 Project State Detection:**
|
|
759
|
+
|
|
760
|
+
- [ ] Scan for source directories (src/, app/, lib/, etc.)
|
|
761
|
+
- [ ] Check for framework files (nest-cli.json, manage.py, etc.)
|
|
762
|
+
- [ ] Check for package managers (package.json, requirements.txt, etc.)
|
|
763
|
+
- [ ] Check for existing README.md
|
|
764
|
+
- [ ] Classify project: New / Initialized / Existing
|
|
765
|
+
- [ ] Present detection results with recommendation
|
|
766
|
+
|
|
767
|
+
**8.2 Framework Initialization (if new project):**
|
|
768
|
+
|
|
769
|
+
- [ ] Ask user if they want to initialize framework
|
|
770
|
+
- [ ] If yes:
|
|
771
|
+
- [ ] Backup .ai-flow/ docs to temp-backup/
|
|
772
|
+
- [ ] Execute appropriate framework CLI command
|
|
773
|
+
- [ ] Restore .ai-flow/ docs from temp-backup/
|
|
774
|
+
- [ ] Handle README.md conflict if framework created one
|
|
775
|
+
- [ ] If no: Show manual command and continue
|
|
776
|
+
|
|
777
|
+
**8.3 Generate Final Documentation:**
|
|
778
|
+
|
|
779
|
+
- [ ] Re-read ALL 10 previously generated documents
|
|
780
|
+
- [ ] Generate docs/business-flows.md (from Phase 1)
|
|
781
|
+
- [ ] Generate docs/api.md (from Phase 2 + Phase 3)
|
|
782
|
+
- [ ] Generate docs/contributing.md (from Phase 5 + Phase 7)
|
|
783
|
+
|
|
784
|
+
**8.4 Generate AGENT.md:**
|
|
785
|
+
|
|
786
|
+
- [ ] Re-read ALL documents again to ensure accuracy
|
|
787
|
+
- [ ] Create master index listing all 15 documents
|
|
788
|
+
- [ ] Include quick reference (tech stack, rules, commands)
|
|
789
|
+
- [ ] Validate all links
|
|
790
|
+
|
|
791
|
+
**8.5 Generate README.md:**
|
|
792
|
+
|
|
793
|
+
- [ ] Re-read ALL documents for complete context
|
|
794
|
+
- [ ] If framework README exists: merge intelligently
|
|
795
|
+
- [ ] If no framework README: create from template
|
|
796
|
+
- [ ] Ensure comprehensive content from all phases
|
|
797
|
+
- [ ] Validate all internal links
|
|
798
|
+
|
|
799
|
+
**8.6 Create Tool-Specific Configs:**
|
|
800
|
+
|
|
801
|
+
- [ ] Based on Phase 3 (question 3.8) AI tool selection
|
|
802
|
+
- [ ] Create .clauderules (if Claude)
|
|
803
|
+
- [ ] Create .cursorrules (if Cursor)
|
|
804
|
+
- [ ] Create .github/copilot-instructions.md (if Copilot)
|
|
805
|
+
- [ ] Create all three (if "All")
|
|
806
|
+
|
|
807
|
+
**8.7 Final Validation:**
|
|
808
|
+
|
|
809
|
+
- [ ] Check for placeholder text in all files
|
|
810
|
+
- [ ] Validate file references
|
|
811
|
+
- [ ] Ensure all links work
|
|
812
|
+
- [ ] Verify template completeness
|
|
813
|
+
- [ ] Show complete success message with next steps
|
|
814
|
+
|
|
815
|
+
**DO NOT:**
|
|
816
|
+
|
|
817
|
+
- ❌ Skip project state detection
|
|
818
|
+
- ❌ Force framework initialization without asking
|
|
819
|
+
- ❌ Overwrite framework README without merging
|
|
820
|
+
- ❌ Generate documents without re-reading previous ones
|
|
821
|
+
- ❌ Leave placeholder text in final documents
|
|
822
|
+
- ❌ Skip tool-specific config generation
|
|
823
|
+
- ❌ Forget to show next steps
|
|
824
|
+
|
|
825
|
+
**ESTIMATED TIME:**
|
|
826
|
+
|
|
827
|
+
- 8.1: Detection - 1-2 min
|
|
828
|
+
- 8.2: Framework init (optional) - 2-5 min
|
|
829
|
+
- 8.3: Final docs - 3-5 min
|
|
830
|
+
- 8.4: AGENT.md - 1-2 min
|
|
831
|
+
- 8.5: README.md - 2-3 min
|
|
832
|
+
- 8.6: Tool configs - 1 min
|
|
833
|
+
- 8.7: Validation - 1 min
|
|
834
|
+
- **Total: 10-15 minutes**
|
|
835
|
+
|
|
836
|
+
---
|
|
837
|
+
|
|
838
|
+
**FINAL STEP: Offer Phase 9 (Implementation Roadmap)**
|
|
839
|
+
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
843
|
+
✅ PHASE 8 COMPLETE: PROJECT READY FOR DEVELOPMENT
|
|
844
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
845
|
+
|
|
846
|
+
🎯 All documentation generated and validated!
|
|
847
|
+
📁 Project initialized and ready
|
|
848
|
+
📖 AGENT.md and README.md created
|
|
849
|
+
⚙️ AI tool configurations in place
|
|
850
|
+
|
|
851
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
852
|
+
🗺️ Optional: Generate Implementation Roadmap?
|
|
853
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
854
|
+
|
|
855
|
+
Phase 9 will analyze all your documentation and generate a complete
|
|
856
|
+
implementation roadmap with:
|
|
857
|
+
|
|
858
|
+
✅ Epics organized by domain
|
|
859
|
+
✅ Features with Story Point estimations (Fibonacci scale)
|
|
860
|
+
✅ Task breakdown with acceptance criteria
|
|
861
|
+
✅ Dependency graph and execution order
|
|
862
|
+
✅ Parallelization opportunities
|
|
863
|
+
✅ Production readiness checklist
|
|
864
|
+
✅ Ready-to-execute /feature commands
|
|
865
|
+
|
|
866
|
+
⏱️ Estimated time: 15-30 minutes
|
|
867
|
+
|
|
868
|
+
Would you like to continue to Phase 9?
|
|
869
|
+
|
|
870
|
+
A) ✅ Yes, generate roadmap now (recommended)
|
|
871
|
+
→ Will analyze {{ENTITIES_COUNT}} entities, {{ENDPOINTS_COUNT}} endpoints
|
|
872
|
+
→ Will create complete implementation plan
|
|
873
|
+
|
|
874
|
+
B) ⏭️ Skip for now (you can run Phase 9 later)
|
|
875
|
+
→ You can start coding with /feature command manually
|
|
876
|
+
→ Run Phase 9 anytime: Just ask "Continue to Phase 9"
|
|
877
|
+
|
|
878
|
+
Your choice (A/B): \_\_
|
|
879
|
+
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
**If choice A:** Continue to Phase 9 (flow-bootstrap-phase-9.md)
|
|
883
|
+
|
|
884
|
+
**If choice B:** Show completion message:
|
|
885
|
+
|
|
886
|
+
```
|
|
887
|
+
|
|
888
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
889
|
+
✅ DOCUMENTATION COMPLETE - READY TO BUILD
|
|
890
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
891
|
+
|
|
892
|
+
Your project is fully documented and initialized! 🎉
|
|
893
|
+
|
|
894
|
+
📖 Next steps:
|
|
895
|
+
|
|
896
|
+
1. Review your documentation in .ai-flow/
|
|
897
|
+
2. Start implementing features with /feature command
|
|
898
|
+
3. Generate roadmap anytime by asking "Continue to Phase 9"
|
|
899
|
+
|
|
900
|
+
Happy coding! 🚀
|
|
901
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
902
|
+
|
|
903
|
+
```
|
|
904
|
+
|
|
905
|
+
---
|
|
906
|
+
|
|
907
|
+
**CONTINUE TO:** Phase 9 (optional) or End
|
|
908
|
+
|
|
909
|
+
**SUCCESS:** Project fully documented and ready for development! 🚀
|
|
910
|
+
```
|
|
911
|
+
|