---
title: "Docs Module"
module_id: "docs"
version: "1.0.0"
category: "content"
autonomy: "agent-capable"
generated: true
generated_at: "2026-05-04"
---

# Docs

> Public documentation portal — auto-synced from the GitHub docs/ folder, browsable at /docs with embedded AI chat for evaluators.

Ships with **1 agent skill**.

## Quick Facts

| Property | Value |
|----------|-------|
| **Module ID** | `docs` |
| **Version** | 1.0.0 |
| **Category** | content |
| **Autonomy** | agent-capable |
| **Core** | No |
| **Capabilities** | `data:read` |
| **MCP-exposed skills** | 1 |
| **Owns tables** | — |

## Skills

These skills are seeded into `agent_skills` when the module is enabled and exposed via MCP.
External operators (FlowPilot, OpenClaw, Claude Desktop, custom MCP clients) can call them directly.

| Skill | Scope | Description |
|-------|-------|-------------|
| `docs_search` | both | Search and read public Flowwink documentation pages (synced from the magnusfroste/flowwink GitHub repo). Use when: a visitor or evaluator asks how Flowwink works, what modules exist, how a process … |

## Module API Contract

**Actions:** `list`, `search`, `get`

**Input fields:** `action`, `query`, `category`, `slug`

**Output fields:** `success`, `message`

## File Map

| Purpose | Path |
|---------|------|
| Module definition | `src/lib/modules/docs-module.ts` |
| Hook | `src/hooks/useDocs.ts` |

## Contributing

To enhance this module, see [Contributing Guide](../contributing/contributing.md).

Key rules:
- Follow `ModuleDefinition<I, O>` contract pattern
- All schema changes require idempotent migrations
- Skills must be self-describing ([Law 2](../concepts/openclaw-law.md))
- Blocks are interfaces, not pipelines ([Law 3](../concepts/openclaw-law.md))
- New skills must pass the [Agent Contract Integrity](../architecture/agent-contract-integrity.md) checklist (`bun run lint:skills`)

---

*This file is auto-generated by `scripts/generate-module-docs.ts`. Do not edit manually — re-run the script after changing the module definition.*