Index for the docs site. Only the Docs site sections below get published; everything under Developer docs stays repo-only (QA guides, design specs, internal references).
| Doc | What it covers |
|---|---|
| getting-started.md | Install from a release or source, providers, first run |
| arch-linux-package.md | Build, upgrade, and uninstall the temporary manual Arch Linux package |
| keybindings.md | Every shortcut, defaults per group, and the editable ~/.crewcode/keys.json override file |
| tweaks-panel.md | The floating Layout panel: density and workspace dock presentation controls |
| system-monitor.md | CPU/memory pill and panel: per-workspace process usage, jump-to and kill controls |
| about-crewcode.md | About card and automatically sourced app/build version |
| Doc | What it covers |
|---|---|
| using-crews.md | Crews: parallel lanes, supervisors, and the select → verify → reconcile → apply Merge lanes workflow |
| reasoning-effort.md | Provider-native reasoning effort levels in the composer and crew lanes |
| realtime-voice.md | Voice orb providers, coding-agent routing, natural spoken replies, credentials, and local roadmap |
| fresh-chat-backgrounds.md | Device-local chat wallpapers, regular-chat coverage, and image-derived app colors |
| prompt-skill-studio.md | Prompt Builder Studio and local .crewcode prompt/skill folders (needs a user-guide rewrite — currently changelog-style) |
| Doc | What it covers |
|---|---|
| security-model.md | Authority-boundary audit: untrusted content -> agent -> MCP/plugin -> exec -> Git/SSH, per-hop gates, tests, and residual risk |
| execution-custody.md | Withdrawing authority after it was granted: invariant tripwire, custody journal, halt/contain/preserve/report, explicit reauthorization |
| remote-ssh-workspaces.md | Opening projects over SSH: setup, auth, host pinning, what works remotely |
| web-remote-access.md | Browser client, crewcode serve, self-hosted Hub relay, and hub --local-brain |
| canvas-mode.md | Workbench: multiple chats and terminals side by side on one worktree (nav label: "Workbench") |
| workspace-session-split.md | Drag a drawer thread onto Solo Chat or a terminal pane to split that view |
| chat-archiving.md | Right-click a chat to archive it; the Archive page, restoring, and retention flagging |
| Doc | What it covers |
|---|---|
| git-workspace.md | The full-page Git tab and its relationship to the Git Sidebar |
| behavioral-merge-review.md | Cross-lane collision signals, merge review gate, provenance, and restart recovery |
| git-authentication.md | One-shot push credential prompts; nothing is persisted |
| git-commit-signing.md | Signing passphrase prompts for GPG/SSH-signed commits |
| Doc | What it covers |
|---|---|
| code-editor.md | The CodeMirror-based editor: language intelligence, themes, AI completions |
| writer-document-formats.md | DOCX/PDF editing through reviewed Markdown working copies |
| Doc | What it covers |
|---|---|
| plugins.md | The plugin contract: manifest, permissions, panel API, CLI workflow |
| plugin-templates.md | Copyable starter templates under examples/plugins/ |
- Notifications —
notifications.mdis a developer API reference; if the notification bar needs user documentation, it's a couple of paragraphs, not that file.
| Doc | What it is |
|---|---|
| conversation-storage.md | Replay shards, session store, /compact strategies, transcript persistence layers |
| agent-provider-context.md | Provider switch handoff, history replay fallback, Claude context policy |
| crewcoder-provider.md | CrewCoder ACP bridge lifecycle, permissions, models, usage, filesystem, and SSH behavior |
| agent-activity-overlay.md | Passive todo/plan/task overlay projection from provider events |
| agent-message-markdown.md | Markdown/Shiki rendering rules for agent replies |
| tool-calling-breakdown.md | Per-tool rendering spec for tool-call rows |
| notifications.md | Notification bar architecture and useNotifications() API reference |
| yuheard.md | Terminal-agent completion protocol, shell wrappers, Codex hook, alert settings, and troubleshooting |
| crew-orchestrator.md | Crew orchestrator design spec: state machine, layering, modes |
| plugins-v0.md | Plugin platform v0 implementation snapshot and pre-v1 gates |
| Doc | What it is |
|---|---|
| crew-manual-test.md | Manual QA script for supervisor ↔ worker round trips |
| dogfood-builds.md | Building installable artifacts for private dogfooding |
| plugin-examples.md | Internal planning list of plugin ideas with validation methods |