Update README documentation in the folder of changed components/abstractions to reflect code changes — keeps docs lean, precise, and in sync
Update README.md files in the folders where code was changed. Documentation lives next to the code it describes — each component/abstraction folder has its own README.
Activate this skill when:
Each folder's README follows this skeleton (sections included only when relevant):
# folder-name/ - Short Purpose
One-sentence overview. Contains **N files**.
## Architecture
[Only if the folder has a non-obvious entry point, router, or coordination pattern]
## Components / Modules / Types
[Table or bullet list of files with one-line descriptions]
## Pattern
[Code snippet showing the common pattern, if one exists]
| Change Type | Documentation Action |
|---|---|
| New file added | Add entry to the file list with one-line description |
| File removed | Remove entry from the file list |
| File renamed | Update the entry |
| New pattern introduced | Add/update the Pattern section |
| Architecture change | Update the Architecture section |
| File count changed | Update the count in the overview line |
| New block/menu/popup type | Add to the relevant type list |
Change: Added `src/ts/component/block/ai.tsx`
Action: Edit `src/ts/component/block/README.md`
- Update file count in overview line
- Add entry under "Other Blocks":
- `ai.tsx` - AI-generated content block
Change: Added `src/ts/store/theme.ts`
Action: Edit `src/ts/store/README.md`
- Add row to the Stores table:
| `theme.ts` | `S.Theme` | Theme management: color schemes, dark mode preferences |
Change: Removed `src/ts/component/menu/legacySearch.tsx`
Action: Edit `src/ts/component/menu/README.md`
- Remove entry for legacySearch from the menu types list
- Update count if mentioned
Change: Created `src/ts/component/block/ai/` with index.tsx, toolbar.tsx, preview.tsx
Action: Create `src/ts/component/block/ai/README.md`:
# ai/ - AI Content Block
AI-generated content blocks with toolbar controls and preview. Contains **3 files**.
## Files
- `index.tsx` - Main block component, renders AI content with edit/regenerate actions
- `toolbar.tsx` - Prompt input and model selection toolbar
- `preview.tsx` - Streaming preview of AI-generated content
Also update parent `src/ts/component/block/README.md` to reference the new subfolder.