Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Where do I…?

When to read this: You know the task but not which file or doc to open. This page is the index of the how-to guides; each guide follows the same shape (goal, prerequisites, steps, verify, checklist, common mistakes).

flowchart TD
  Start[What do you need?] --> UI{Change UI?}
  UI -->|Desktop view| V["chatty-gpui/src/chatty/views/ · add-gpui-view.md"]
  UI -->|Settings page| S["chatty-gpui/src/settings/views/"]
  UI -->|Terminal UI| T["chatty-tui/src/ui/"]
  UI -->|Slash command| SC["add-slash-command.md"]
  UI -->|No| LLM{Change LLM behavior?}
  LLM -->|New tool| Tool["chatty-core/src/tools/ · first-change.md"]
  LLM -->|New provider| Prov["ProviderType + agent_factory/ · add-provider.md"]
  LLM -->|Stream bug| SM["stream-manager.md · debug.md"]
  LLM -->|WASM plugin| WASM["build-wasm-module.md + tutorials"]
  LLM -->|No| Data{Change data/settings?}
  Data -->|New setting| Set["settings/models + repositories + GPUI settings"]
  Data -->|Persistence| Repo["repositories/ or settings/repositories/"]
  Data -->|No| Infra{CI / docs / release?}
  Infra --> WF[".github/workflows/ · ci-reference.md"]
  Infra --> Doc["docs/ + docs-site/ · contribute-docs.md"]
  Infra --> Rel["RELEASE_PROCESS.md"]

How-to guides

GuideUse it when
Add an LLM providerA new ProviderType, or deciding whether an OpenAI-compatible endpoint even needs one
Add a slash commandA new /command in the desktop and terminal pickers
Add a desktop GPUI viewA panel, dialog or widget in chatty-gpui
Build a WASM pluginA sandboxed agent module served by the protocol gateway
TestWhich tests to run, goldens, mocks, the WASM prebuild
DebugLogs, the render overlay, stalled streams, tool failures, cache hits
Build & packageLocal CI and platform packages
Release processCutting a version
Contribute to the docsEditing this site
For AI agentsThe workspace map coding agents read first

Tutorials (learn by building) live under Start here: your first change, write a plugin (echo), give an agent the plugin (benford).

Cheat sheet

I want to…Open
Read the user manualGetting started and the other user pages
Build the workspace for the first timeBuild and run
Understand the big pictureSystem overview
See component diagramsComponent map
Find a workspace crateReference: crates
Build a WASM pluginBuild a WASM plugin · echo tutorial · benford tutorial
Add an LLM toolYour first change: add a tool
Add a providerAdd an LLM provider
Add a slash commandAdd a slash command
Add a GPUI viewAdd a desktop GPUI view
Look up a persisted settingSettings schema
Fix stream/cancel bugsStream lifecycle · Debug
Fix rendering/layoutDebug · Rendering pipeline
Look up a tool nameTools catalog
Change delegation, the broker, virtual agents or teamsAgents and specs · Team smoke test · Sub-agents · tutorials: named worker, team
Run tests like CITest · Make targets & CI workflows
Look up a termGlossary
Research / reserved codeRESERVED.md
Report or fix a stale pageContribute to the docs · CONTRIBUTING.md