Skip to content

cleanup the doc #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hungtd9 merged 1 commit into from
Mar 19, 2026
Merged

cleanup the doc #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions docs/reference/terminology.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

This document defines product terms so that design and documentation stay consistent across the control plane and worker runtime.

## Mental model

- **Control plane** (clawforce): API, auth, scheduling, and state.
- **Data plane / workload runtime** (clawbot): The process or container that runs one agent.
- **Agent** is the logical unit (spec + identity); the **running instance** is the workload (one process or container per agent).

## Term mapping

| Product term | Definition |
Expand Down Expand Up @@ -41,15 +35,6 @@ Plan status is separate: `draft` → `active` → `paused` | `completed`.

External systems (GitHub Projects, Jira) remain the source of truth for their data. Plan is the orchestrator where the coordinator and agents record and orchestrate work. Agents perform any sync; Plan stores the coordination view. The coordinator decides when each agent starts working; not all agents need to be active at once.

## Control plane vs worker (data plane)

- **Control plane** never runs the agent loop or tools; it only:
- Stores agent/team/plan data
- Starts/stops instances via the pool backend
- Proxies WebSocket and API requests to the running instance
- Serves the dashboard and REST API
- **Worker** (clawbot) runs exactly one agent: LLM loop, tools, channels, heartbeat. It connects **to** the control plane and does not accept inbound HTTP from users; all user/operator traffic goes through the control plane.

## Naming conventions in code and config

- **`agent_id`** — Unique id for the agent (logical unit and its data path).
Expand Down
Loading