Forgotten 02dc46e782 docs: add external documentation site content

Add structured documentation covering quickstart, architecture, core
concepts, API reference, adapter guides, CLI commands, deployment
options, and operator/developer guides.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-26 16:33:55 -06:00

1.8 KiB

Raw Blame History

title	summary
Goals and Projects	Goal hierarchy and project management

Goals and Projects API

Goals define the "why" and projects define the "what" for organizing work.

Goals

Goals form a hierarchy: company goals break down into team goals, which break down into agent-level goals.

List Goals

GET /api/companies/{companyId}/goals

Get Goal

GET /api/goals/{goalId}

Create Goal

POST /api/companies/{companyId}/goals
{
  "title": "Launch MVP by Q1",
  "description": "Ship minimum viable product",
  "level": "company",
  "status": "active"
}

Update Goal

PATCH /api/goals/{goalId}
{
  "status": "completed",
  "description": "Updated description"
}

Projects

Projects group related issues toward a deliverable. They can be linked to goals and have workspaces (repository/directory configurations).

List Projects

GET /api/companies/{companyId}/projects

Get Project

GET /api/projects/{projectId}

Returns project details including workspaces.

Create Project

POST /api/companies/{companyId}/projects
{
  "name": "Auth System",
  "description": "End-to-end authentication",
  "goalId": "{goalId}",
  "status": "active"
}

Update Project

PATCH /api/projects/{projectId}
{
  "status": "completed"
}

Project Workspaces

Workspaces link a project to a repository and directory:

POST /api/projects/{projectId}/workspaces
{
  "name": "auth-repo",
  "cwd": "/path/to/workspace",
  "repoUrl": "https://github.com/org/repo",
  "repoRef": "main",
  "isPrimary": true
}

Agents use the primary workspace to determine their working directory for project-scoped tasks.

Manage Workspaces

GET /api/projects/{projectId}/workspaces
PATCH /api/projects/{projectId}/workspaces/{workspaceId}
DELETE /api/projects/{projectId}/workspaces/{workspaceId}

1.8 KiB Raw Blame History