majiayu000 Doc Update
Keep documentation evergreen by updating immediately after code changes.
When to Use
- After completing any code change
- After fixing a bug or adding a feature
- Before running
/handoff - When
/drift-checkidentifies stale docs
Hierarchy
Updates flow from specific to general:
- Feature Docs →
docs/features/{feature}.md - Workflow Docs →
docs/workflows/{role}-workflows.md - Index Files → FEATURE_INDEX.md, WORKFLOW_INDEX.md
- Architecture Docs →
docs/engine/*.md(if patterns changed)
Quick Reference
| Files Changed | Update |
|---|---|
app/actions/*.ts |
Feature doc → Server Actions |
app/(routes)/** |
Feature doc → User Surfaces |
components/** |
Feature doc + Component Index |
supabase/migrations/* |
Feature doc → Data Model + prod SQL |
lib/ai/** |
AI context docs + feature docs |
Feature Doc Sections to Update
- User Surfaces: Routes, UI elements
- Data Model: Tables, columns, relationships
- Server Actions: Action name, purpose, tables, auth
- Permissions: RLS policies, admin client usage
- Invariants: Add newly discovered rules
- Testing Checklist: Update verification steps
Output
## Doc Update Complete
### Updated
| Doc | Sections |
|-----|----------|
| [feature].md | User Surfaces, Data Model |
### Production SQL
- Provided: [Yes/No]
### Verification
Run `/drift-check` to confirm no remaining drift.
Related
- Section templates: See reference/section-templates.md
- Common patterns: See reference/update-patterns.md
- Next step:
/drift-check