- Quick Start — Understand LinkWork's components and launch the platform services
Dive deep into LinkWork's design philosophy and core models.
| Document | Description |
|---|---|
| Workstation Model | Workstation → Instance → Task three-tier model, containerized execution |
| Skills System | Declarative skill definitions, version management, build-time pinning |
| MCP Tools | Standardized external tool access, unified proxy and auth |
| Harness Engineering | One role, one image — build-time immutability, runtime read-only |
Understand the system architecture and key technical decisions.
| Document | Description |
|---|---|
| Architecture Overview | System context, component relationships, tech stack |
| Core Components | Responsibilities and collaboration of the five core components |
| Data Flow & Real-time Communication | Task lifecycle, event streaming, data archival |
| Security Architecture | Multi-layer security model, policy engine, approvals and audit |
Deploy and extend LinkWork from scratch.
| Document | Description |
|---|---|
| Deployment Guide | K8s production deployment, Harbor image registry, infrastructure requirements |
| Extension Guide | Full capability stack, custom roles, Skills, MCP, file management, Git projects |
Understand how LinkWork is used through real-world scenarios.
| Document | Description |
|---|---|
| Literature Tracker | Complete role configuration example using Tavily MCP search |
Each component repository maintains its own detailed documentation (API Reference, protocol specs, etc.):
| Component | Description | Docs Location |
|---|---|---|
| linkwork-server | Core backend — task scheduling, role management | linkwork-server/docs/ |
| linkwork-executor | Secure executor — command execution, policy engine | linkwork-executor/docs/ |
| linkwork-agent-sdk | Agent runtime — LLM engine, Skills orchestration | linkwork-agent-sdk/docs/ |
| linkwork-mcp-gateway | MCP tool gateway — tool discovery, auth | linkwork-mcp-gateway/docs/ |
| linkwork-web | Frontend reference — task dashboard, role config | linkwork-web/docs/ |
Component documentation will be published progressively as each component is open-sourced.