Skip to content

Commit 26880cc

Browse files
binarykclaude
andcommitted
docs: add intelligent workflow section to README
Added: - Workflow diagram showing discover → explore → flow pipeline - Example session with all commands - "What Makes It Smart" capability table 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 8b80f67 commit 26880cc

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,48 @@ The intelligent commands build a `.docs-knowledge/` folder:
233233

234234
This knowledge powers smarter documentation generation.
235235

236+
## Intelligent Workflow
237+
238+
The recommended flow for comprehensive documentation:
239+
240+
```
241+
/docs:discover campaigns → Analyzes code, builds knowledge graph
242+
243+
/docs:explore campaigns → Playwright explores UI, finds behaviors
244+
245+
/docs:flow campaign → Documents complete lifecycle with screenshots
246+
```
247+
248+
### Example Session
249+
250+
```bash
251+
# 1. List all detectable modules
252+
/docs:discover --list
253+
254+
# 2. Analyze the campaigns module deeply
255+
/docs:discover campaigns --deep --with-flows
256+
257+
# 3. Explore UI to discover conditional fields & validation
258+
/docs:explore campaigns
259+
260+
# 4. Generate full lifecycle documentation
261+
/docs:flow campaign --lifecycle --include-errors
262+
263+
# 5. Update docs after code changes
264+
/docs:update --base main
265+
```
266+
267+
### What Makes It Smart
268+
269+
| Capability | How It Works |
270+
|------------|--------------|
271+
| **Conditional UI** | Clicks checkboxes/toggles, observes what fields appear |
272+
| **Validation Discovery** | Submits empty/invalid forms, captures error messages |
273+
| **Cross-Page Tracking** | Creates data, verifies it appears in lists/dashboards |
274+
| **Entity Lifecycle** | Documents full create → view → edit → delete flow |
275+
| **Modular Analysis** | One module at a time, scales to large projects |
276+
| **Code + UI Correlation** | Matches frontend components to backend validation |
277+
236278
## Configuration
237279

238280
After running `/docs:init`, a `docs-config.yaml` is created:

0 commit comments

Comments
 (0)