Skip to content

Commit 2546650

Browse files
committed
docs: add usage flow diagram with setup, document, and sync stages
1 parent 7720b07 commit 2546650

1 file changed

Lines changed: 49 additions & 9 deletions

File tree

README.md

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,63 @@ pipx install aidocs-cli
4343
## Quick Start
4444

4545
```bash
46-
# Initialize in current directory
46+
# Install the CLI
47+
uv tool install aidocs-cli
48+
49+
# Add to your project
4750
aidocs init .
51+
```
4852

49-
# Check your environment
50-
aidocs check
53+
## Usage Flow
54+
55+
```
56+
┌──────────────────────────────────────────────────────────────────────────────┐
57+
│ SETUP (once) │
58+
├──────────────────────────────────────────────────────────────────────────────┤
59+
│ │
60+
│ $ aidocs init . Install commands into project │
61+
│ │ │
62+
│ ▼ │
63+
│ /docs:init Configure: name, auth, style, output │
64+
│ │
65+
└──────────────────────────────────────────────────────────────────────────────┘
66+
67+
68+
┌──────────────────────────────────────────────────────────────────────────────┐
69+
│ DOCUMENT A MODULE │
70+
├──────────────────────────────────────────────────────────────────────────────┤
71+
│ │
72+
│ /docs:discover campaigns Analyze code: models, routes, validation │
73+
│ │ │
74+
│ ▼ │
75+
│ /docs:explore campaigns Test UI: click buttons, fill forms │
76+
│ │ │
77+
│ ▼ │
78+
│ /docs:flow campaign --lifecycle Generate: create → view → edit → delete │
79+
│ │
80+
└──────────────────────────────────────────────────────────────────────────────┘
81+
82+
83+
┌──────────────────────────────────────────────────────────────────────────────┐
84+
│ KEEP DOCS IN SYNC │
85+
├──────────────────────────────────────────────────────────────────────────────┤
86+
│ │
87+
│ # After implementing a feature: │
88+
│ /docs:update --base main Detect changes, update affected docs │
89+
│ │
90+
└──────────────────────────────────────────────────────────────────────────────┘
5191
```
5292

53-
Then in Claude Code:
93+
### Quick Commands
5494

5595
```bash
56-
# Configure your project
57-
/docs:init
58-
59-
# Generate docs for a page
96+
# Simple: Generate docs for one page
6097
/docs:generate https://myapp.com/dashboard
6198

62-
# Update docs after code changes
99+
# Smart: Full module documentation
100+
/docs:discover campaigns && /docs:explore campaigns && /docs:flow campaign
101+
102+
# Maintain: Update after code changes
63103
/docs:update --base main
64104
```
65105

0 commit comments

Comments
 (0)