docs: restructure all READMEs from ~1500 to ~250 lines with i18n sub-documents#1729
Merged
lxowalle merged 1 commit intosipeed:mainfrom Mar 18, 2026
Merged
Conversation
Restructure all 6 README files (en, zh, ja, fr, pt-br, vi) from
~1200-1580 lines down to ~250 lines each. Long sections (Chat Apps,
Providers, Configuration, Docker, Spawn Tasks, Troubleshooting, Tools)
are extracted into dedicated docs under docs/{lang}/ subdirectories.
Changes:
- Split README content into 7 sub-documents per language (42 new files)
- Update News section with v0.2.3/v0.2.1/v0.2.0/20K milestones
- Add 3 new Features (MCP Support, Vision Pipeline, Smart Routing)
- Complete CLI reference (14 commands, was 7)
- Fix Go badge 1.21+ -> 1.25+ (matches go.mod)
- Add LoongArch to architecture badge
- Fix Install section: hardcoded v0.1.1 -> latest/download URL
- Add Termux GitHub links
- Fix currency symbol placement ($599 not 599$)
- Add missing channels (Feishu, Slack, IRC, OneBot, MaixCam, Pico)
- Add missing providers (Kimi, Minimax, Avian, Mistral, Longcat, ModelScope)
- Add missing security docs (allow_read/write_paths, allow_remote, symlink)
- Remove incorrect azure from Providers table (azure uses model_list only)
- Cross-verified all claims against source code
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds and localizes PicoClaw documentation (multiple languages) covering provider/model configuration, tools configuration, Docker quick start, troubleshooting, and spawn/async task usage to help users set up and operate the system correctly.
Changes:
- Add new localized docs for providers/model configuration and troubleshooting guidance.
- Add new localized docs for tools configuration (web, exec, cron, MCP, skills).
- Add/expand Docker quick start docs and spawn/async task docs.
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 23 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/providers.md | Provider/model_list overview and configuration examples (EN). |
| docs/zh/providers.md | Provider/model_list overview and configuration examples (ZH). |
| docs/pt-br/providers.md | Provider/model_list overview and configuration examples (PT-BR). |
| docs/zh/troubleshooting.md | Troubleshooting guide (ZH), including OpenRouter model ID guidance. |
| docs/vi/troubleshooting.md | Troubleshooting guide (VI). |
| docs/pt-br/troubleshooting.md | Troubleshooting guide (PT-BR). |
| docs/fr/troubleshooting.md | Troubleshooting guide (FR). |
| docs/ja/troubleshooting.md | Troubleshooting guide (JA). |
| docs/zh/tools_configuration.md | Tools configuration reference (ZH). |
| docs/vi/tools_configuration.md | Tools configuration reference (VI). |
| docs/pt-br/tools_configuration.md | Tools configuration reference (PT-BR). |
| docs/ja/tools_configuration.md | Tools configuration reference (JA). |
| docs/fr/tools_configuration.md | Tools configuration reference (FR). |
| docs/spawn-tasks.md | Spawn/async tasks documentation (EN). |
| docs/zh/spawn-tasks.md | Spawn/async tasks documentation (ZH). |
| docs/vi/spawn-tasks.md | Spawn/async tasks documentation (VI). |
| docs/pt-br/spawn-tasks.md | Spawn/async tasks documentation (PT-BR). |
| docs/fr/spawn-tasks.md | Spawn/async tasks documentation (FR). |
| docs/configuration.md | Configuration guide updates (EN), including spawn section. |
| docs/vi/configuration.md | Configuration guide updates (VI), including spawn section. |
| docs/pt-br/configuration.md | Configuration guide updates (PT-BR), including spawn section. |
| docs/fr/configuration.md | Configuration guide updates (FR), including spawn section. |
| docs/docker.md | Docker/Quick Start guide updates (EN). |
| docs/zh/docker.md | Docker/Quick Start guide updates (ZH). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+9
to
+13
| ## Long Tasks (use spawn for async) | ||
|
|
||
| - Search the web for AI news and summarize | ||
| - Check email and report important messages | ||
| ``` |
Comment on lines
+9
to
+13
| ## Tác Vụ Dài (sử dụng spawn cho bất đồng bộ) | ||
|
|
||
| - Tìm kiếm web tin tức AI và tóm tắt | ||
| - Kiểm tra email và báo cáo tin nhắn quan trọng | ||
| ``` |
|
|
||
| - Pesquisar na web notícias sobre IA e resumir | ||
| - Verificar e-mail e relatar mensagens importantes | ||
| ``` |
|
|
||
| - Rechercher sur le web des actualités IA et résumer | ||
| - Vérifier les emails et rapporter les messages importants | ||
| ``` |
Comment on lines
+213
to
+218
| #### Async Tasks with Spawn | ||
|
|
||
| For long-running tasks (web search, API calls), use the `spawn` tool to create a **subagent**: | ||
|
|
||
| ```markdown | ||
| # Periodic Tasks |
Comment on lines
+67
to
+79
| ## Ferramenta Exec | ||
|
|
||
| A ferramenta exec é usada para executar comandos shell. | ||
|
|
||
| | Config | Tipo | Padrão | Descrição | | ||
| |------------------------|-------|--------|-------------------------------------------------| | ||
| | `enable_deny_patterns` | bool | true | Habilitar bloqueio padrão de comandos perigosos | | ||
| | `custom_deny_patterns` | array | [] | Padrões de negação personalizados (expressões regulares) | | ||
|
|
||
| ### Funcionalidade | ||
|
|
||
| - **`enable_deny_patterns`**: Defina como `false` para desabilitar completamente os padrões de bloqueio de comandos perigosos padrão | ||
| - **`custom_deny_patterns`**: Adicione padrões regex de negação personalizados; comandos correspondentes serão bloqueados |
Comment on lines
+67
to
+79
| ## Exec ツール | ||
|
|
||
| Exec ツールはシェルコマンドの実行に使用されます。 | ||
|
|
||
| | 設定項目 | 型 | デフォルト | 説明 | | ||
| |------------------------|-------|------------|------------------------------------| | ||
| | `enable_deny_patterns` | bool | true | デフォルトの危険コマンドブロックを有効にする | | ||
| | `custom_deny_patterns` | array | [] | カスタム拒否パターン（正規表現） | | ||
|
|
||
| ### 機能 | ||
|
|
||
| - **`enable_deny_patterns`**：`false` に設定すると、デフォルトの危険コマンドブロックパターンを完全に無効にします | ||
| - **`custom_deny_patterns`**：カスタム拒否正規表現パターンを追加します。一致するコマンドはブロックされます |
Comment on lines
+61
to
+79
| | Config | Type | Par défaut | Description | | ||
| |---------------|--------|------------|--------------------------------| | ||
| | `enabled` | bool | false | Activer la recherche Perplexity | | ||
| | `api_key` | string | - | Clé API Perplexity | | ||
| | `max_results` | int | 5 | Nombre maximum de résultats | | ||
|
|
||
| ## Outil Exec | ||
|
|
||
| L'outil exec est utilisé pour exécuter des commandes shell. | ||
|
|
||
| | Config | Type | Par défaut | Description | | ||
| |------------------------|-------|------------|------------------------------------------------| | ||
| | `enable_deny_patterns` | bool | true | Activer le blocage par défaut des commandes dangereuses | | ||
| | `custom_deny_patterns` | array | [] | Modèles de refus personnalisés (expressions régulières) | | ||
|
|
||
| ### Fonctionnalité | ||
|
|
||
| - **`enable_deny_patterns`** : Définir à `false` pour désactiver complètement les modèles de blocage par défaut des commandes dangereuses | ||
| - **`custom_deny_patterns`** : Ajouter des modèles regex de refus personnalisés ; les commandes correspondantes seront bloquées |
| "model_name": "ark-code-latest", | ||
| "model": "volcengine/ark-code-latest", | ||
| "api_key": "sk-your-api-key", | ||
| "api_base":"https://ark.cn-beijing.volces.com/api/coding/v3" |
Comment on lines
+93
to
+98
| { | ||
| "model_name": "ark-code-latest", | ||
| "model": "volcengine/ark-code-latest", | ||
| "api_key": "sk-your-api-key", | ||
| "api_base":"https://ark.cn-beijing.volces.com/api/coding/v3" | ||
| }, |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/{lang}/What changed
README restructure
docs/sub-documentsContent updates & fixes
releases/latest/download/dynamic URL599$→$599across all languagesCross-verified against source code
azurefrom Providers table (Azure uses model_list prefix only, no dedicated provider config)enable_deny_patternsdefault istruevia defaults.goi18n documentation structure
Note