# Pi Rich Questions documentation

Start with the page that matches your task:

## Use the package

- [Getting started](getting-started.md) — requirements; npm, Git, and local installation; updates; disabling; removal.
- [Authoring questions](authoring-questions.md) — choose question types and write detailed, stable tool inputs.
- [Commands and configuration](commands-and-configuration.md) — `ask_rich_questions`, `/rich-questions`, extraction models, authentication, validation, and fallback.
- [Interaction and accessibility](interaction-and-accessibility.md) — configured keys, fullscreen mouse input, multiline editing, scrolling, terminals, cancellation, and recovery.
- [Result contract](result-contract.md) — model-facing text, structured `details`, values, indexes, notes, and compatibility.
- [Troubleshooting](troubleshooting.md) — common runtime, extraction, keyboard, rendering, and extension-conflict problems.
- [Security and privacy](security-and-privacy.md) — extension trust, provider data, sensitive content, and safe diagnostics.

## Understand or maintain the package

- [Architecture](architecture.md) — modules, data flow, form state, editor/Markdown integration, layout, and mode guards.
- [Development](development.md) — Pi compatibility matrix, setup, automated test areas, coverage, fixtures, and regular/fullscreen TUI checks.
- [Releasing](releasing.md) — versioning, changelog, package inspection, publishing, deployment, and rollback.

Project-level policies live in [CONTRIBUTING.md](../CONTRIBUTING.md), [SECURITY.md](../SECURITY.md), [CHANGELOG.md](../CHANGELOG.md), and the [MIT license](../LICENSE). Remaining documentation work is tracked in [TODOs.md](TODOs.md).
