# HoldSpeak documentation

This index lists every guide and reference by reader task.
The product overview and install steps are in the [root README](../README.md).
A line marked "(overlaps X)" repeats part of X. Read X first.

## Use

| You want to | Read |
| --- | --- |
| See what HoldSpeak does | [What is HoldSpeak?](WHAT_IS_HOLDSPEAK.md) |
| Choose a workflow by the result you need | [Use cases](USE_CASES.md) |
| Install HoldSpeak and keep a first sentence | [Getting Started](GETTING_STARTED.md) |
| Do a daily task or find a control | [User Guide](USER_GUIDE.md) |
| Learn a product term | [Glossary](GLOSSARY.md) |
| Dictate into another app | [Voice typing](USER_GUIDE.md#voice-typing) |
| Set up the dictation pipeline | [Dictation pipeline](DICTATION_PIPELINE_GUIDE.md) |
| See one enriched dictation run | [Dictation Copilot](DICTATION_COPILOT.md) |
| Map spoken keywords to actions | [Voice commands](VOICE_COMMANDS.md) |
| Review recent activity before you dictate | [Activity pre-briefing](ACTIVITY_PREBRIEFING.md) |
| Record, import, and review a meeting | [Meeting mode](MEETING_MODE_GUIDE.md) |
| Read the follow-up digest of a meeting | [Meeting aftercare](MEETING_AFTERCARE.md) |
| Describe your goals, Projects, and decisions | [Interview](INTERVIEW.md) |
| Prepare a decision brief or agent brief | [Architecture work](ARCHITECTURE_WORK.md) |
| Work with Desk objects and windows | [The Desk](WEB_DESK.md) |
| Review attention items and Receipts | [Missed](DESK_MEMORY.md) |
| Find earlier work across your records | [Memory](RELATIONSHIP_AWARE_MEMORY.md) |
| Connect sources to a Project | [Project Rooms](PROJECT_ROOMS.md) |
| Select a Place or use Settle in | [Places](ENVIRONMENTS.md) |
| Use confidential relationship records | [People integration](PEOPLE_INTEGRATION.md) |
| Use Threads, Agents, and Workflows | [Agents and Threads](AGENTS_AND_THREADS.md) |
| Use HoldSpeak on an iPad | [iPad](IPAD.md) |
| Use the AIPI-Lite device | [AIPI-Lite](AIPI_LITE.md) |
| Install the browser activity connector | [Firefox extension](FIREFOX_EXTENSION_GUIDE.md) |

## Configure

| You want to | Read |
| --- | --- |
| Select engines and assign models | [Models](MODELS.md) |
| Understand models versus assignments | [Inference targets](INFERENCE_TARGETS.md) (overlaps [Models](MODELS.md)) |
| Choose a manual, event, or scheduled run | [Automation](AUTOMATION.md) |
| Review open loops on a schedule | [Cadence](CADENCE.md) |
| Set a Control mode | [Control modes](AUTHORITY.md) |
| Guard coding agent tool calls | [Gate](GATE.md) |
| Connect Claude Code or Codex sessions | [Agent hooks](AGENT_HOOK_INSTALL.md) |
| Steer coder sessions from the Desk | [Coder integration](CODER_INTEGRATION.md) |
| Connect an MCP client (285 tools across 49 families) | [MCP sidecar](MCP_SIDECAR.md) |
| Run a remote sweep and steward | [Reach Runner](REACH_RUNNER.md) |
| Set up connectors and actuators | [Integrations](INTEGRATIONS.md) |
| Place work on a destination | [Execution destinations](EXECUTION_DESTINATIONS.md) |
| Look up a configuration field | [Configuration reference](CONFIGURATION_REFERENCE.md) |

## Extend

| You want to | Read |
| --- | --- |
| Write a meeting plugin | [Plugin authoring](PLUGIN_AUTHORING.md) |
| Write an activity connector | [Connector development](CONNECTOR_DEVELOPMENT.md) |
| Write an actuator | [Actuator development](ACTUATOR_DEVELOPMENT.md) |
| Build for a portable device | [AIPI-Lite workflow](AIPI_LITE_DEV_WORKFLOW.md) and [Device protocol](DEVICE_PROTOCOL.md) |
| Find an HTTP route | [API surface](API_SURFACE.md) and [API reference](API_REFERENCE.md) (overlaps [API surface](API_SURFACE.md)) |
| Find a capability and its evidence | [Capabilities](CAPABILITIES.md) |
| Build or change a Web surface | [Design author map](../web/README.md#design-author-map), [UX Canon](internal/UX-CANON.md), and [Design System](internal/DESIGN_SYSTEM.md) |
| Follow shared component APIs | [Surface contract](../web/src/desk/surface/contract.md); executable examples in the desk's Components window |
| Change the code | [Contributing](../CONTRIBUTING.md) |

## Operate

| You want to | Read |
| --- | --- |
| Run the doctor, back up, and restore | [Operations](OPERATIONS.md) |
| Fix a failed job or refusal | [Troubleshooting](TROUBLESHOOTING.md) |
| Upgrade and release | [Releasing](RELEASING.md) |
| Repair the database | [Storage and migrations](STORAGE_AND_MIGRATIONS.md) |
| Read the security contract | [Security and privacy](SECURITY.md) |
| Protect People records | [People security](PEOPLE_SECURITY.md) |
| Check platform support | [Platform matrix](PLATFORMS.md) |

## Architecture

| You want to | Read |
| --- | --- |
| See the system on one page | [System architecture](SYSTEM_ARCHITECTURE.md) |
| Read the runtime map | [Architecture](ARCHITECTURE.md) |
| See the deployment and job owners | [System integration map](SYSTEM_INTEGRATION_MAP.md) (overlaps [System architecture](SYSTEM_ARCHITECTURE.md) and [Kernel](KERNEL.md)) |
| Read the operation runtime | [Kernel](KERNEL.md) |
| Read the domain terms | [Domain model](DOMAIN_MODEL.md) |
| Read the tables and keys | [Data model](DATA_MODEL.md) (overlaps [Domain model](DOMAIN_MODEL.md)) |
| Trace a model call | [Model runtime](MODEL_RUNTIME.md) |
| Trace authority to code | [Authority model](AUTHORITY_MODEL.md) |
| Read the security controls | [Security model](SECURITY_MODEL.md) |
| Read the dictation code path | [Dictation architecture](DICTATION_ARCHITECTURE.md) |
| Read the meeting code path | [Meeting architecture](MEETING_ARCHITECTURE.md) and [Meeting intelligence](MEETING_INTELLIGENCE.md) |
| Read the Desk code | [Desk architecture](DESK_ARCHITECTURE.md) and [Desk object model](DESK_OBJECT_MODEL.md) |
| Read the companion topology | [Companions architecture](COMPANIONS_ARCHITECTURE.md) |

## Internal records

The [native-experience research](internal/betterment/native-experience/README.md)
records the React-stack direction, source audit, browser capabilities and
proposed production-pattern delivery plan. It distinguishes research from
shipped behavior and aesthetic acceptance.

Files under [internal](internal/) hold canon, plans, and history.
Canon states the current rules. Plans can describe behavior that is not built;
release records describe their named revision and observed scope. Use the
[design author map](../web/README.md#design-author-map) for current interface
ownership and the [modernization record](internal/betterment/MODERNIZATION-IMPLEMENTATION-2026-10-22.md)
for this implementation's adoption and verification.