diff --git a/docs/README.md b/docs/README.md index 0e5f38b4e..529eb49ec 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,6 +6,19 @@ This file describes the recommended documentation layout, how translated files s These conventions are intended as contributor guidance for new or moved docs. Existing docs may still have historical exceptions, and `make lint-docs` only checks a common subset of the patterns described here. +## Reader Navigation + +If you are browsing docs rather than reorganizing them, start with these directory indexes: + +- [Guides](guides/README.md): setup, configuration, provider, and workflow guides. +- [Reference](reference/README.md): precise configuration and behavior reference. +- [Operations](operations/README.md): debugging and troubleshooting material. +- [Security](security/README.md): security-focused guides and controls. +- [Architecture](architecture/README.md): implementation notes and internal design docs. +- [Migration](migration/README.md): upgrade and migration notes. + +For channel-specific setup, start with [Chat Apps Configuration](guides/chat-apps.md) and then drill into `docs/channels//README.md` as needed. + ## Principles - Choose the document type directory first. Do not create language buckets such as `docs/zh/` or `docs/fr/`. diff --git a/docs/architecture/README.md b/docs/architecture/README.md new file mode 100644 index 000000000..1803bc84f --- /dev/null +++ b/docs/architecture/README.md @@ -0,0 +1,10 @@ +# Architecture + +Internal architecture notes for major runtime mechanisms and subsystem design. + +- [Steering](steering.md): injecting messages into a running agent loop between tool calls. +- [SubTurn Mechanism](subturn.md): sub-agent coordination, concurrency control, and lifecycle handling. +- [Hook System Guide](hooks/README.md): current hook architecture and protocol details. +- [Agent Refactor](agent-refactor/README.md): notes and checkpoints for the agent refactor work. + +For proposal-style or exploratory docs, also see [`../design/`](../design/). diff --git a/docs/guides/README.md b/docs/guides/README.md new file mode 100644 index 000000000..93ed679d5 --- /dev/null +++ b/docs/guides/README.md @@ -0,0 +1,13 @@ +# Guides + +Task-oriented guides for setup, configuration, and common PicoClaw workflows. + +- [Docker & Quick Start Guide](docker.md): install and run PicoClaw with Docker or the launcher. +- [Configuration Guide](configuration.md): environment variables, workspace layout, routing, and sandbox settings. +- [Chat Apps Configuration](chat-apps.md): supported chat platforms and channel-specific setup paths. +- [Providers & Model Configuration](providers.md): `model_list`, providers, and model routing. +- [Spawn & Async Tasks](spawn-tasks.md): background work, long-running tasks, and sub-agent orchestration. +- [PicoClaw Hardware Compatibility List](hardware-compatibility.md): tested boards and platform notes. +- [Using Antigravity Provider in PicoClaw](ANTIGRAVITY_USAGE.md): Google Cloud Code Assist setup and usage. + +Translations usually live beside the English source when available. diff --git a/docs/migration/README.md b/docs/migration/README.md new file mode 100644 index 000000000..eb37eec20 --- /dev/null +++ b/docs/migration/README.md @@ -0,0 +1,5 @@ +# Migration + +Migration notes for major configuration and behavior changes across PicoClaw versions. + +- [Migration Guide: From `providers` to `model_list`](model-list-migration.md): update legacy provider config to the current `model_list` format. diff --git a/docs/operations/README.md b/docs/operations/README.md new file mode 100644 index 000000000..b775ca3d9 --- /dev/null +++ b/docs/operations/README.md @@ -0,0 +1,6 @@ +# Operations + +Operational docs for debugging, diagnosis, and production troubleshooting. + +- [Troubleshooting](troubleshooting.md): common failures, symptoms, and recovery steps. +- [Debugging PicoClaw](debug.md): logs, runtime visibility, and debugging workflow. diff --git a/docs/project/README.fr.md b/docs/project/README.fr.md index 98ebbae71..1e2f59bee 100644 --- a/docs/project/README.fr.md +++ b/docs/project/README.fr.md @@ -475,7 +475,7 @@ Parlez à votre PicoClaw via plus de 17 plateformes de messagerie : | **DingTalk** | Moyen (identifiants client) | Stream | [Guide](../channels/dingtalk/README.fr.md) | | **Feishu / Lark** | Moyen (App ID + Secret) | WebSocket/SDK | [Guide](../channels/feishu/README.fr.md) | | **LINE** | Moyen (identifiants + webhook) | Webhook | [Guide](../channels/line/README.fr.md) | -| **WeCom** | Facile (QR login ou manuel) | WebSocket | [Guide](../channels/wecom/README.md) | +| **WeCom** | Facile (QR login ou manuel) | WebSocket | [Guide](../channels/wecom/README.fr.md) | | **IRC** | Moyen (serveur + pseudo) | Protocole IRC | [Guide](../guides/chat-apps.fr.md#irc) | | **OneBot** | Moyen (URL WebSocket) | OneBot v11 | [Guide](../channels/onebot/README.fr.md) | | **MaixCam** | Facile (activer) | Socket TCP | [Guide](../channels/maixcam/README.fr.md) | diff --git a/docs/project/README.ja.md b/docs/project/README.ja.md index 2c0599d56..66d06ba5e 100644 --- a/docs/project/README.ja.md +++ b/docs/project/README.ja.md @@ -471,7 +471,7 @@ Provider の完全な設定詳細は [Provider とモデル](../guides/providers | **DingTalk** | 中級(クライアント認証情報) | Stream | [ガイド](../channels/dingtalk/README.ja.md) | | **Feishu / Lark** | 中級(App ID + Secret) | WebSocket/SDK | [ガイド](../channels/feishu/README.ja.md) | | **LINE** | 中級(認証情報 + webhook) | Webhook | [ガイド](../channels/line/README.ja.md) | -| **WeCom** | 簡単(QR ログインまたは手動) | WebSocket | [ガイド](../channels/wecom/README.md) | +| **WeCom** | 簡単(QR ログインまたは手動) | WebSocket | [ガイド](../channels/wecom/README.ja.md) | | **IRC** | 中級(サーバー + nick) | IRC protocol | [ガイド](../guides/chat-apps.ja.md#irc) | | **OneBot** | 中級(WebSocket URL) | OneBot v11 | [ガイド](../channels/onebot/README.ja.md) | | **MaixCam** | 簡単(有効化) | TCP socket | [ガイド](../channels/maixcam/README.ja.md) | diff --git a/docs/project/README.ms.md b/docs/project/README.ms.md index 4033bd441..abf7d104b 100644 --- a/docs/project/README.ms.md +++ b/docs/project/README.ms.md @@ -462,16 +462,16 @@ Bercakap dengan PicoClaw anda melalui 17+ platform pemesejan: |---------|-----------|----------|-----| | **Telegram** | Mudah (token bot) | Long polling | [Panduan](../channels/telegram/README.md) | | **Discord** | Mudah (token bot + intents) | WebSocket | [Panduan](../channels/discord/README.md) | -| **WhatsApp** | Mudah (imbas QR atau URL jambatan) | Natif / Jambatan | [Panduan](../guides/chat-apps.md#whatsapp) | -| **Weixin** | Mudah (imbas QR natif) | iLink API | [Panduan](../guides/chat-apps.md#weixin) | +| **WhatsApp** | Mudah (imbas QR atau URL jambatan) | Natif / Jambatan | [Panduan](../guides/chat-apps.ms.md#whatsapp) | +| **Weixin** | Mudah (imbas QR natif) | iLink API | [Panduan](../guides/chat-apps.ms.md#weixin) | | **QQ** | Mudah (AppID + AppSecret) | WebSocket | [Panduan](../channels/qq/README.md) | | **Slack** | Mudah (token bot + app) | Socket Mode | [Panduan](../channels/slack/README.md) | | **Matrix** | Sederhana (homeserver + token) | Sync API | [Panduan](../channels/matrix/README.md) | | **DingTalk** | Sederhana (kelayakan klien) | Stream | [Panduan](../channels/dingtalk/README.md) | | **Feishu / Lark** | Sederhana (App ID + Secret) | WebSocket/SDK | [Panduan](../channels/feishu/README.md) | | **LINE** | Sederhana (kelayakan + webhook) | Webhook | [Panduan](../channels/line/README.md) | -| **WeCom** | Mudah (log masuk QR atau manual) | WebSocket | [Panduan](../channels/wecom/README.md) | -| **IRC** | Sederhana (pelayan + nick) | Protokol IRC | [Panduan](../guides/chat-apps.md#irc) | +| **WeCom** | Mudah (log masuk QR atau manual) | WebSocket | [Panduan](../channels/wecom/README.ms.md) | +| **IRC** | Sederhana (pelayan + nick) | Protokol IRC | [Panduan](../guides/chat-apps.ms.md#irc) | | **OneBot** | Sederhana (URL WebSocket) | OneBot v11 | [Panduan](../channels/onebot/README.md) | | **MaixCam** | Mudah (aktifkan) | TCP socket | [Panduan](../channels/maixcam/README.md) | | **Pico** | Mudah (aktifkan) | Protokol natif | Terbina dalam | @@ -479,7 +479,7 @@ Bercakap dengan PicoClaw anda melalui 17+ platform pemesejan: > Semua saluran berasaskan webhook berkongsi satu pelayan HTTP Gateway (`gateway.host`:`gateway.port`, lalai `127.0.0.1:18790`). Feishu menggunakan mod WebSocket/SDK dan tidak menggunakan pelayan HTTP yang dikongsi. -> Tahap perincian log dikawal oleh `gateway.log_level` (lalai: `warn`). Nilai yang disokong: `debug`, `info`, `warn`, `error`, `fatal`. Boleh juga ditetapkan melalui `PICOCLAW_LOG_LEVEL`. Lihat [Konfigurasi](../guides/configuration.md#gateway-log-level) untuk butiran. +> Tahap perincian log dikawal oleh `gateway.log_level` (lalai: `warn`). Nilai yang disokong: `debug`, `info`, `warn`, `error`, `fatal`. Boleh juga ditetapkan melalui `PICOCLAW_LOG_LEVEL`. Lihat [Konfigurasi](../guides/configuration.ms.md#gateway-log-level) untuk butiran. Untuk arahan persediaan saluran terperinci, lihat [Konfigurasi Aplikasi Sembang](../guides/chat-apps.ms.md). diff --git a/docs/project/README.pt-br.md b/docs/project/README.pt-br.md index ab08243fb..56d4ddd63 100644 --- a/docs/project/README.pt-br.md +++ b/docs/project/README.pt-br.md @@ -471,7 +471,7 @@ Converse com seu PicoClaw por meio de mais de 17 plataformas de mensagens: | **DingTalk** | Médio (credenciais do cliente) | Stream | [Guia](../channels/dingtalk/README.pt-br.md) | | **Feishu / Lark** | Médio (App ID + Secret) | WebSocket/SDK | [Guia](../channels/feishu/README.pt-br.md) | | **LINE** | Médio (credenciais + webhook) | Webhook | [Guia](../channels/line/README.pt-br.md) | -| **WeCom** | Fácil (login QR ou manual) | WebSocket | [Guia](../channels/wecom/README.md) | +| **WeCom** | Fácil (login QR ou manual) | WebSocket | [Guia](../channels/wecom/README.pt-br.md) | | **IRC** | Médio (servidor + nick) | Protocolo IRC | [Guia](../guides/chat-apps.pt-br.md#irc) | | **OneBot** | Médio (WebSocket URL) | OneBot v11 | [Guia](../channels/onebot/README.pt-br.md) | | **MaixCam** | Fácil (habilitar) | TCP socket | [Guia](../channels/maixcam/README.pt-br.md) | diff --git a/docs/project/README.vi.md b/docs/project/README.vi.md index 52dc01bf9..52a56796b 100644 --- a/docs/project/README.vi.md +++ b/docs/project/README.vi.md @@ -471,7 +471,7 @@ Trò chuyện với PicoClaw của bạn qua 17+ nền tảng nhắn tin: | **DingTalk** | Trung bình (client credentials) | Stream | [Hướng dẫn](../channels/dingtalk/README.vi.md) | | **Feishu / Lark** | Trung bình (App ID + Secret) | WebSocket/SDK | [Hướng dẫn](../channels/feishu/README.vi.md) | | **LINE** | Trung bình (credentials + webhook) | Webhook | [Hướng dẫn](../channels/line/README.vi.md) | -| **WeCom** | Dễ (đăng nhập QR hoặc thủ công) | WebSocket | [Hướng dẫn](../channels/wecom/README.md) | +| **WeCom** | Dễ (đăng nhập QR hoặc thủ công) | WebSocket | [Hướng dẫn](../channels/wecom/README.vi.md) | | **IRC** | Trung bình (server + nick) | IRC protocol | [Hướng dẫn](../guides/chat-apps.vi.md#irc) | | **OneBot** | Trung bình (WebSocket URL) | OneBot v11 | [Hướng dẫn](../channels/onebot/README.vi.md) | | **MaixCam** | Dễ (bật) | TCP socket | [Hướng dẫn](../channels/maixcam/README.vi.md) | diff --git a/docs/reference/README.md b/docs/reference/README.md new file mode 100644 index 000000000..eec5c09b4 --- /dev/null +++ b/docs/reference/README.md @@ -0,0 +1,8 @@ +# Reference + +Reference docs for precise configuration, runtime behavior, and tool semantics. + +- [Tools Configuration](tools_configuration.md): per-tool configuration, execution policies, MCP, and Skills. +- [Scheduled Tasks and Cron Jobs](cron.md): schedule types, delivery modes, command gates, and storage. +- [Config Schema Versioning Guide](config-versioning.md): config schema migration and compatibility notes. +- [Dynamic Rate Limiting](rate-limiting.md): request throttling behavior for LLM providers. diff --git a/docs/security/README.md b/docs/security/README.md new file mode 100644 index 000000000..7bd42da18 --- /dev/null +++ b/docs/security/README.md @@ -0,0 +1,8 @@ +# Security + +Security-focused docs covering configuration, secrets handling, and provider auth. + +- [Security Configuration](security_configuration.md): security-related config knobs and hardening guidance. +- [Sensitive Data Filtering](sensitive_data_filtering.md): filtering secrets from tool output before model use. +- [Credential Encryption](credential_encryption.md): encrypting stored API keys and credentials. +- [Antigravity Authentication & Integration Guide](ANTIGRAVITY_AUTH.md): auth flow and integration notes for the Antigravity provider.