diff --git a/README.md b/README.md index 0c689238..6fb9a3cf 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ---

- AgentCompany dashboard + AgentCompany dashboard

## What it does @@ -60,42 +60,42 @@ Switch at Settings → Execution mode. CEO builds the org chart from one goal.

- Org chart + Org chart

### Agent messaging Threads and DMs between agents. Direct / department / project / company / incident channels resolve to wake targets; each message lands in the recipient's transcript as a pi `AgentMessage` turn. If the recipient is already running, the message is delivered live via pi's steer queue; if not, it waits in the inbox until the next prepareRun.

- Agent messaging + Agent messaging

### Tasks Goals break into tasks. Agents pick them up, report progress, escalate blockers.

- Task queue + Task queue

### Approvals Hiring, deliverables, plan/scope/strategy reviews, budget overrides, production deploys pause for the board. The same approval policy gates the agent's destructive tools (`bash` / `write` / `edit`) via pi's `beforeToolCall` hook, so a pending approval stops file and shell mutations instead of just flagging them after the fact.

- Approvals + Approvals

### Documents Plans, strategies, and specs in a shared center, linked to the tasks that produced them.

- Document center + Document center

### Launch in a minute Name, mission, goal, provider, mode.

- Onboarding + Onboarding

--- @@ -173,6 +173,22 @@ src/ --- +## Top-level directories + +| Path | Purpose | +|------|---------| +| `src/` | TypeScript source for main / preload / renderer / shared. | +| `tests/` | Vitest unit + integration, Playwright e2e, `tests/eval/` for LLM-behavior eval. | +| `assets/` | App icons, tray icons, and macOS entitlements. Referenced by `electron-builder.yml` and `src/main/index.ts` — must stay at repo root. | +| `builtin-skills/` | Agent skill bundles shipped with the app. Loaded at runtime from `process.cwd()` or `process.resourcesPath` (see `src/main/skills/runtime.ts`) and packaged by `electron-builder.yml`. Must stay at repo root. | +| `docs/` | Contributor-facing documentation, proposals, release notes, and README screenshots (`docs/screenshots/`). | +| `scripts/` | Build, release, and packaging Node scripts. | +| `landing/` | Marketing site (Next.js). Has its own `landing/public/screenshots/`, separate from `docs/screenshots/`. | +| `AgentCompany-Rust/` | Exploratory Rust port; see section below. | +| `pi-mono-reference/` | Read-only reference checkout of the pi-mono SDK used by the runtime. | + +--- + ## AgentCompany-Rust The `AgentCompany-Rust/` directory is an exploratory parallel implementation of the runtime in Rust (GPUI-based desktop shell, SQLite storage, pi bridge). It shares the product concept with the TypeScript app and keeps its own `Cargo.toml` workspace, PRD, and progress notes under `AgentCompany-Rust/`. diff --git a/screenshots/AI-Internal-Realtime-Message.jpeg b/docs/screenshots/AI-Internal-Realtime-Message.jpeg similarity index 100% rename from screenshots/AI-Internal-Realtime-Message.jpeg rename to docs/screenshots/AI-Internal-Realtime-Message.jpeg diff --git a/screenshots/Approval-by-Human.jpeg b/docs/screenshots/Approval-by-Human.jpeg similarity index 100% rename from screenshots/Approval-by-Human.jpeg rename to docs/screenshots/Approval-by-Human.jpeg diff --git a/screenshots/Auto-OrgChart-Team.jpeg b/docs/screenshots/Auto-OrgChart-Team.jpeg similarity index 100% rename from screenshots/Auto-OrgChart-Team.jpeg rename to docs/screenshots/Auto-OrgChart-Team.jpeg diff --git a/screenshots/Auto-Task.jpeg b/docs/screenshots/Auto-Task.jpeg similarity index 100% rename from screenshots/Auto-Task.jpeg rename to docs/screenshots/Auto-Task.jpeg diff --git a/screenshots/Dashboard.jpeg b/docs/screenshots/Dashboard.jpeg similarity index 100% rename from screenshots/Dashboard.jpeg rename to docs/screenshots/Dashboard.jpeg diff --git a/screenshots/Document-Center.jpeg b/docs/screenshots/Document-Center.jpeg similarity index 100% rename from screenshots/Document-Center.jpeg rename to docs/screenshots/Document-Center.jpeg diff --git a/screenshots/Onboarding.jpeg b/docs/screenshots/Onboarding.jpeg similarity index 100% rename from screenshots/Onboarding.jpeg rename to docs/screenshots/Onboarding.jpeg