# Documentation

Use this page as the documentation index for `pi-yaml-hooks`.

| If you want to... | Read |
|---|---|
| Install the extension or choose a config path | [Setup](./setup.md) |
| Understand every field, event, action, and payload | [Hooks reference](./hooks-reference.md) |
| Copy a working hook and adapt it | [Examples](./examples.md) |
| Find out why a hook did not run | [Debugging hooks](./debugging-hooks.md) |
| Test a release or compatibility change | [Maintaining](./maintaining.md) |

Start with [Setup](./setup.md), then copy the closest configuration from [Examples](./examples.md). Keep the [Hooks reference](./hooks-reference.md) open when you need exact behavior.

The top-level [README](../README.md) is the short product overview. Complete script-backed packs are under [`examples/`](../examples/).