Skip to content

Commit cc69263

Browse files
committed
feat: /docs:flow defaults to full lifecycle, use --only for specific flow
1 parent 7299634 commit cc69263

2 files changed

Lines changed: 13 additions & 9 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ aidocs init .
6969
│ DOCUMENT A MODULE │
7070
├──────────────────────────────────────────────────────────────────────────────┤
7171
│ │
72-
│ /docs:flow campaign --lifecycle ← Just run this one command! │
72+
│ /docs:flow campaign ← Just run this one command! │
7373
│ │ │
7474
│ ├──→ Auto-runs /docs:discover campaign (analyzes code) │
7575
│ ├──→ Auto-runs /docs:explore campaign (tests UI) │
@@ -95,7 +95,7 @@ aidocs init .
9595
/docs:generate https://myapp.com/dashboard
9696

9797
# Smart: Full module documentation (auto-discovers and explores)
98-
/docs:flow campaign --lifecycle
98+
/docs:flow campaign
9999

100100
# Maintain: Update after code changes
101101
/docs:update --base main
@@ -252,8 +252,9 @@ Interactively explore a module's UI with Playwright:
252252
Document a complete entity lifecycle. **Auto-runs discover and explore if needed.**
253253

254254
```bash
255-
/docs:flow campaign # Smart flow detection
256-
/docs:flow campaign --lifecycle # Full CRUD documentation
255+
/docs:flow campaign # Full CRUD lifecycle (default)
256+
/docs:flow campaign --only create # Only document create flow
257+
/docs:flow campaign --only edit # Only document edit flow
257258
/docs:flow "user registration" # Custom flow description
258259
/docs:flow order --include-errors # Include error states
259260
/docs:flow campaign --skip-explore # Skip UI exploration (faster)
@@ -262,7 +263,7 @@ Document a complete entity lifecycle. **Auto-runs discover and explore if needed
262263
**What happens:**
263264
1. Auto-runs `/docs:discover` if module not analyzed yet
264265
2. Auto-runs `/docs:explore` if UI not explored yet
265-
3. Documents the complete flow with screenshots
266+
3. Documents full lifecycle (create → view → edit → delete) by default
266267

267268
**Produces step-by-step guides with:**
268269
- Screenshots at each step

src/aidocs_cli/templates/workflows/flow/workflow.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,21 @@ description: Document a complete entity lifecycle or custom user flow with cross
1717

1818
Parse the arguments:
1919
```
20-
/docs:flow <entity|"custom description"> [--lifecycle] [--include-errors] [--skip-explore] [--output]
20+
/docs:flow <entity|"custom description"> [--only <action>] [--include-errors] [--skip-explore] [--output]
2121
```
2222

2323
Examples:
2424
```
25-
/docs:flow campaign # Smart detection of main flow
26-
/docs:flow campaign --lifecycle # Full CRUD: create, view, edit, delete
25+
/docs:flow campaign # Full CRUD lifecycle (default)
26+
/docs:flow campaign --only create # Only document create flow
27+
/docs:flow campaign --only edit # Only document edit flow
2728
/docs:flow "user registration" # Custom flow by description
2829
/docs:flow order --include-errors # Include error states
29-
/docs:flow campaign --skip-explore # Skip UI exploration (use existing knowledge)
30+
/docs:flow campaign --skip-explore # Skip UI exploration (faster)
3031
```
3132

33+
**Default behavior:** Documents full lifecycle (create → view → edit → delete)
34+
3235
---
3336

3437
## STEP 1: AUTO-RUN PREREQUISITES

0 commit comments

Comments
 (0)