# CommonTools Documentation

This directory contains documentation for pattern developers and framework contributors.

## For Pattern Developers

### Essential (read before writing patterns)

| Doc | Description |
|-----|-------------|
| [PATTERNS.md](PATTERNS.md) | Main tutorial with examples - **start here** |
| [CELLS_AND_REACTIVITY.md](CELLS_AND_REACTIVITY.md) | Core reactive programming model |
| [COMPONENTS.md](COMPONENTS.md) | UI components reference (ct-input, ct-button, etc.) |
| [TYPES_AND_SCHEMAS.md](TYPES_AND_SCHEMAS.md) | Type system, Cell<>, Default<>, schemas |

### Workflow (read when doing these tasks)

| Doc | Description |
|-----|-------------|
| [DEBUGGING.md](DEBUGGING.md) | Troubleshooting errors and common gotchas |
| [LOCAL_DEV_SERVERS.md](LOCAL_DEV_SERVERS.md) | Setting up local development servers |

### Specialized (read when using these features)

| Doc | Description |
|-----|-------------|
| [LLM.md](LLM.md) | AI/LLM integration with generateText/generateObject |
| [CHARM_LINKING.md](CHARM_LINKING.md) | Multi-charm patterns and data sharing |
| [FAVORITES.md](FAVORITES.md) | Favorites and wish() system |
| [HOME_SPACE.md](HOME_SPACE.md) | Home space concepts |
| [CELL_CONTEXT.md](CELL_CONTEXT.md) | ct-cell-context debugging tool |

---

## For Framework Contributors

These docs are for people working on the CommonTools runtime itself, not pattern authors.

| Doc | Description |
|-----|-------------|
| [RUNTIME.md](RUNTIME.md) | Runtime package internals and architecture |
| [DEVELOPMENT.md](DEVELOPMENT.md) | Code style, design principles, contribution guidelines |
| [UI_TESTING.md](UI_TESTING.md) | Integration test setup with Playwright |