<!-- AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY -->
<!-- Edit source frontmatter, then run 'erk docs sync' to regenerate. -->

# Agent Documentation

Before starting work, scan the read-when conditions below.
If your current task matches, read the linked document **before writing code**.

## Categories

- [architecture/](architecture/) — Explore when working on core patterns (dry-run, gateways, subprocess, shell integration). Add docs here for cross-cutting technical patterns.
- [capabilities/](capabilities/)
- [changelog/](changelog/)
- [checklists/](checklists/)
- [ci/](ci/)
- [claude-code/](claude-code/)
- [cli/](cli/) — Explore when building CLI commands or output formatting. Add docs here for Click patterns and terminal UX.
- [commands/](commands/) — Explore when creating or optimizing slash commands. Add docs here for command authoring patterns.
- [config/](config/)
- [configuration/](configuration/)
- [desktop-dash/](desktop-dash/)
- [documentation/](documentation/) — Explore when structuring or writing documentation. Add docs here for documentation methodology and best practices.
- [erk/](erk/) — Explore when working with erk-specific workflows (worktrees, PR sync, Graphite). Add docs here for erk user-facing features.
- [erk-dev/](erk-dev/)
- [gateway/](gateway/)
- [hooks/](hooks/) — Explore when creating or debugging hooks. Add docs here for hook development patterns.
- [integrations/](integrations/)
- [objectives/](objectives/)
- [planning/](planning/) — Explore when working with plans, .impl/ folders, or agent delegation. Add docs here for planning workflow patterns.
- [pr-operations/](pr-operations/)
- [refactoring/](refactoring/)
- [reference/](reference/) — Explore for API/format specifications. Add docs here for reference material that doesn't fit other categories.
- [review/](review/)
- [reviews/](reviews/)
- [sessions/](sessions/) — Explore when working with session logs or parallel sessions. Add docs here for session management patterns.
- [testing/](testing/) — Explore when writing tests or debugging test infrastructure. Add docs here for testing patterns specific to erk.
- [textual/](textual/) — Explore when working with Textual framework. Add docs here for Textual-specific patterns.
- [tui/](tui/) — Explore when working on the erk TUI application. Add docs here for TUI feature implementation.
- [workflows/](workflows/)

## Uncategorized

- **[claude-md-best-practices.md](claude-md-best-practices.md)** — writing or updating CLAUDE.md or AGENTS.md files, creating project documentation for AI agents, setting up new agent-driven projects
- **[conventions.md](conventions.md)** — naming functions or variables, creating CLI commands, naming Claude artifacts, moving code between packages, creating imports, creating immutable classes or frozen dataclasses, implementing an ABC with abstract properties
- **[glossary.md](glossary.md)** — understanding project terminology, confused about domain-specific terms, working with worktrees, plans, or stacks, working with objectives or turns
- **[guide.md](guide.md)** — navigating erk documentation, finding where documentation lives, understanding doc organization
- **[universal-tripwires.md](universal-tripwires.md)** — starting any coding task, writing new code in erk
