# FlowWink Documentation

> A modular, self-hosted **Business Operating System**. Modules, skills, automations and MCP work standalone — the autonomous operator (**FlowPilot**, OpenClaw, Claude Desktop, or any MCP client) is opt-in.

Structure inspired by [OpenClaw](https://github.com/openclaw/openclaw).

---

## Two audiences, two paths

| You are… | Start here |
|---|---|
| **Operator** — running FlowWink for a business | [`operators/`](./operators/README.md) → install, configure modules, drive day-to-day work |
| **Builder** — extending or contributing to FlowWink | [`builders/`](./builders/README.md) → add modules, blocks, skills, templates |

Both paths share the **concepts** below. Everything else (guides, modules, reference, processes) is referenced from the two landing pages.

---

## Concepts — read these first (both audiences)

| Doc | Why |
|---|---|
| [`concepts/elevator-pitch.md`](./concepts/elevator-pitch.md) | One-page positioning |
| [`concepts/operator-strategy.md`](./concepts/operator-strategy.md) | Why FlowPilot is a module, not the core |
| [`concepts/openclaw-law.md`](./concepts/openclaw-law.md) | The 10 inviolable agentic laws |
| [`concepts/flowchat-vs-flowpilot.md`](./concepts/flowchat-vs-flowpilot.md) | Utility AI vs operator AI |
| [`concepts/prd.md`](./concepts/prd.md) | Full system reference — modules, processes, scope |

---

## Folder map

| Folder | Contents | Audience |
|---|---|---|
| [`concepts/`](./concepts/) | Architecture, vision, laws | both |
| [`operators/`](./operators/README.md) | Install, configure, run | operators |
| [`builders/`](./builders/README.md) | Extend, contribute, test | builders |
| [`guides/`](./guides/) | Docker, deploy, migrate, maintain | operators |
| [`modules/`](./modules/) | One page per module — auto-generated from `defineModule()` | both |
| [`processes/`](./processes/) | End-to-end flows (lead-to-customer, quote-to-cash, …) | both |
| [`pilot/`](./pilot/) | FlowPilot internals — handlers, memory, heartbeat | builders |
| [`architecture/`](./architecture/) | Platform layers (MCP, event bus, locale packs, tiers) | builders |
| [`reference/`](./reference/) | Module API, headless REST/GraphQL, skill registry, commands | both |
| [`mcp/`](./mcp/) | MCP resources for external agents | builders |
| [`agents/`](./agents/) | Department-claw playbooks (sales / marketing / finance / ops / support / success) | operators |
| [`contributing/`](./contributing/) | How to contribute, run tests | builders |

---

## Quick links

- **65 modules** registered in `src/lib/modules/` — every one has a page in [`modules/`](./modules/) (alias-aware via `scripts/check-doc-drift.ts`)
- **8 business processes** documented in [`processes/`](./processes/)
- **6 department-claw playbooks** in [`agents/`](./agents/) for external MCP operators
- Public docs portal: [/docs](https://flowwink.com/docs) (auto-synced from this folder, with embedded AI chat)

---

*Edit any page on GitHub → push → an admin runs the sync from `/admin/docs` (or wait for the scheduled sync).*
