Skip to content

docs: fix inaccuracies and add missing translations#1819

Closed
BeaconCat wants to merge 5 commits intosipeed:mainfrom
BeaconCat:docs/fix-inaccuracies-and-add-translations
Closed

docs: fix inaccuracies and add missing translations#1819
BeaconCat wants to merge 5 commits intosipeed:mainfrom
BeaconCat:docs/fix-inaccuracies-and-add-translations

Conversation

@BeaconCat
Copy link
Copy Markdown
Contributor

@BeaconCat BeaconCat commented Mar 20, 2026

Summary

  • Fix 25+ documentation inaccuracies found by cross-checking against v0.2.3 codebase
  • Fix 15 broken internal links across all language versions
  • Add 25 missing translation files (5 docs × 5 languages)
  • Sync all README translations with English version

Fixes (cross-verified against Go source)

Config field errors:

  • MaixCamConfig: server_addresshost + port
  • IRCConfig: use_tlstls, channels_to_joinchannels
  • GatewayConfig: WeCom AI Bot callback port 1879118790
  • ModelConfig: base_urlapi_base in credential_encryption example
  • AgentDefaults: agents.defaults.modelmodel_name (providers.md ×4, migration guide, troubleshooting, ANTIGRAVITY_AUTH)
  • SessionConfig: removed non-existent backlog_limit field
  • credential_encryption: added missing required model field in model_list example
  • credential_encryption: removed incorrect passphrase-only mode docs (SSH key is required per deriveKey())

Tools configuration gaps:

  • Added Tavily, SearXNG, GLMSearch search engines
  • Added exec allow_remote, timeout_seconds, custom_allow_patterns
  • Added cron allow_command
  • Added skills github, search_cache, clawhub timeout/max_zip_size/max_response_size

File path / version errors:

  • ANTIGRAVITY_AUTH: cmd_auth.gointernal/auth/helpers.go, Go 1.211.25
  • spawn-tasks: fixed truncated file, added Heartbeat introduction
  • configuration: HEARTBEAT.md marked as auto-generated; builtin skills path corrected

Getting-started accuracy:

  • README: added missing picoclaw model CLI command (v0.2.3 new)
  • README: added comment explaining termux-chroot purpose
  • docker.md: clarified first-run trigger condition
  • configuration.md: fixed builtin skills path description

Broken link fixes (15 total)

  • chat-apps.md: WeCom/Matrix links with wrong relative paths
  • providers.md: migration link with extra docs/ prefix
  • hardware-compatibility.md: README links with wrong depth
  • chat-apps.md: WhatsApp dead links → anchor links

New translations (25 files)

Document zh ja fr pt-br vi
debug.md
credential_encryption.md
hardware-compatibility.md
ANTIGRAVITY_AUTH.md
ANTIGRAVITY_USAGE.md

All 5 language directories now have 12 docs each, matching the English docs/ directory.

Test plan

  • Verify all internal doc links resolve correctly on GitHub
  • Spot-check translated content for accuracy
  • Confirm config examples match config/config.example.json and pkg/config/config.go

Copilot AI review requested due to automatic review settings March 20, 2026 06:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation set to align with the v0.2.3 codebase, adds missing translations across multiple languages, and synchronizes translated docs with the English source.

Changes:

  • Corrects configuration key names/values and tool/channel documentation to match current behavior (e.g., model_name, credential encryption, new tool options).
  • Adds/updates translated documentation files (vi/pt-br/ja/fr) to close gaps and improve parity with English.
  • Introduces/refreshes guides for Docker, tools configuration, chat apps, hardware compatibility, and async/spawn tasks.

Reviewed changes

Copilot reviewed 59 out of 80 changed files in this pull request and generated 15 comments.

Show a summary per file
File Description
docs/vi/chat-apps.md Adds Vietnamese chat-app configuration guide content.
docs/vi/ANTIGRAVITY_USAGE.md Adds Vietnamese Antigravity usage guide.
docs/troubleshooting.md Updates OpenRouter troubleshooting to use model_name.
docs/tools_configuration.md Documents additional web engines and expanded exec/skills options.
docs/spawn-tasks.md Adds Heartbeat/spawn tasks documentation.
docs/pt-br/troubleshooting.md Adds Portuguese troubleshooting page synced to new model_name wording.
docs/pt-br/tools_configuration.md Adds Portuguese tools configuration page.
docs/pt-br/spawn-tasks.md Adds Portuguese spawn tasks page.
docs/pt-br/providers.md Adds Portuguese providers/model configuration guide.
docs/pt-br/hardware-compatibility.md Adds Portuguese hardware compatibility list.
docs/pt-br/docker.md Adds Portuguese Docker quick start guide.
docs/pt-br/debug.md Adds Portuguese debugging guide.
docs/pt-br/credential_encryption.md Adds Portuguese credential encryption guide.
docs/pt-br/configuration.md Adds Portuguese configuration guide.
docs/pt-br/chat-apps.md Adds Portuguese chat-app configuration guide.
docs/pt-br/ANTIGRAVITY_USAGE.md Adds Portuguese Antigravity usage guide.
docs/providers.md Adds English providers/model configuration guide.
docs/migration/model-list-migration.md Updates migration guide examples/checklist to model_name.
docs/ja/troubleshooting.md Adds Japanese troubleshooting page synced to model_name.
docs/ja/tools_configuration.md Adds Japanese tools configuration page.
docs/ja/spawn-tasks.md Adds Japanese spawn tasks guide.
docs/ja/hardware-compatibility.md Adds Japanese hardware compatibility list.
docs/ja/docker.md Adds Japanese Docker quick start guide.
docs/ja/debug.md Adds Japanese debugging guide.
docs/ja/credential_encryption.md Adds Japanese credential encryption guide.
docs/ja/configuration.md Adds Japanese configuration guide.
docs/ja/ANTIGRAVITY_USAGE.md Adds Japanese Antigravity usage guide.
docs/hardware-compatibility.md Adds English hardware compatibility list.
docs/fr/troubleshooting.md Adds French troubleshooting page synced to model_name.
docs/fr/tools_configuration.md Adds French tools configuration page.
docs/fr/spawn-tasks.md Adds French spawn tasks page.
docs/fr/hardware-compatibility.md Adds French hardware compatibility list.
docs/fr/docker.md Adds French Docker quick start guide.
docs/fr/debug.md Adds French debugging guide.
docs/fr/credential_encryption.md Adds French credential encryption guide.
docs/fr/configuration.md Adds French configuration guide.
docs/fr/ANTIGRAVITY_USAGE.md Adds French Antigravity usage guide.
docs/docker.md Adds English Docker quick start guide.
docs/credential_encryption.md Fixes credential encryption doc keys and removes passphrase-only mode docs.
docs/configuration.md Adds English configuration guide with workspace/security/heartbeat sections.
docs/chat-apps.md Adds English chat-app configuration guide.
docs/channels/wecom/wecom_aibot/README.zh.md Fixes WeCom AI Bot callback port documentation to 18790.
docs/channels/matrix/README.zh.md Documents Matrix message_format option.
docs/channels/maixcam/README.zh.md Updates MaixCam config fields to host + port.
docs/ANTIGRAVITY_AUTH.md Updates Antigravity auth dev-doc references and Go version note.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

picoclaw gateway
```

Để xem đầy đủ các tùy chọn (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), xem [Hướng Dẫn Cấu Hình Kênh Matrix](channels/matrix/README.md).
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These relative links are likely incorrect from within docs/vi/ (they currently resolve under docs/vi/...). Update them to point to the actual docs root, e.g. ../channels/matrix/README.md and ../channels/wecom/wecom_aibot/README.zh.md (or the correct target language path if one exists).

Suggested change
Để xem đầy đủ các tùy chọn (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), xem [Hướng Dẫn Cấu Hình Kênh Matrix](channels/matrix/README.md).
Để xem đầy đủ các tùy chọn (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), xem [Hướng Dẫn Cấu Hình Kênh Matrix](../channels/matrix/README.md).

Copilot uses AI. Check for mistakes.
**Tùy chọn 2: WeCom App (App Tùy chỉnh)** - Nhiều tính năng hơn, nhắn tin chủ động, chỉ chat riêng
**Tùy chọn 3: WeCom AI Bot (AI Bot)** - AI Bot chính thức, phản hồi streaming, hỗ trợ chat nhóm & riêng

Xem [Hướng Dẫn Cấu Hình WeCom AI Bot](docs/channels/wecom/wecom_aibot/README.zh.md) để biết hướng dẫn thiết lập chi tiết.
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These relative links are likely incorrect from within docs/vi/ (they currently resolve under docs/vi/...). Update them to point to the actual docs root, e.g. ../channels/matrix/README.md and ../channels/wecom/wecom_aibot/README.zh.md (or the correct target language path if one exists).

Suggested change
Xem [Hướng Dẫn Cấu Hình WeCom AI Bot](docs/channels/wecom/wecom_aibot/README.zh.md) để biết hướng dẫn thiết lập chi tiết.
Xem [Hướng Dẫn Cấu Hình WeCom AI Bot](../channels/wecom/wecom_aibot/README.zh.md) để biết hướng dẫn thiết lập chi tiết.

Copilot uses AI. Check for mistakes.
picoclaw gateway
```

Para opções completas (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), veja o [Guia de Configuração do Canal Matrix](channels/matrix/README.md).
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the Vietnamese version: from docs/pt-br/, these relative links likely 404 because they resolve under docs/pt-br/.... Prefer ../channels/matrix/README.md and ../channels/wecom/wecom_aibot/README.zh.md (or the correct localized doc paths) so GitHub renders working links.

Suggested change
Para opções completas (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), veja o [Guia de Configuração do Canal Matrix](channels/matrix/README.md).
Para opções completas (`device_id`, `join_on_invite`, `group_trigger`, `placeholder`, `reasoning_channel_id`), veja o [Guia de Configuração do Canal Matrix](../channels/matrix/README.md).

Copilot uses AI. Check for mistakes.
**Opção 2: WeCom App (App Personalizado)** - Mais recursos, mensagens proativas, apenas chat privado
**Opção 3: WeCom AI Bot (AI Bot)** - AI Bot oficial, respostas em streaming, suporta chat de grupo e privado

Veja o [Guia de Configuração do WeCom AI Bot](docs/channels/wecom/wecom_aibot/README.zh.md) para instruções detalhadas de configuração.
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the Vietnamese version: from docs/pt-br/, these relative links likely 404 because they resolve under docs/pt-br/.... Prefer ../channels/matrix/README.md and ../channels/wecom/wecom_aibot/README.zh.md (or the correct localized doc paths) so GitHub renders working links.

Suggested change
Veja o [Guia de Configuração do WeCom AI Bot](docs/channels/wecom/wecom_aibot/README.zh.md) para instruções detalhadas de configuração.
Veja o [Guia de Configuração do WeCom AI Bot](../channels/wecom/wecom_aibot/README.zh.md) para instruções detalhadas de configuração.

Copilot uses AI. Check for mistakes.
Comment on lines +5 to +12
## Tarefas Rápidas (resposta direta)

- Informar a hora atual

## Tarefas Longas (usar spawn para assíncrono)

- Pesquisar na web notícias sobre IA e resumir
- Verificar e-mail e relatar mensagens importantes
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 13 starts a fenced code block, but there is no corresponding opening fence for the preceding list—this breaks Markdown rendering (it will treat following sections as code until the next fence). Remove this stray fence or replace the whole section with the intended fenced example (as in the English docs/spawn-tasks.md).

Copilot uses AI. Check for mistakes.
Se você está implantando via Coolify ou Docker, siga estas etapas para testar:

1. **Variáveis de ambiente**:
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the Vietnamese version: if the documented config key is agents.defaults.model_name, the env var should be updated to PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME=... for consistency and correctness.

Suggested change
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
* `PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME=gemini-flash`

Copilot uses AI. Check for mistakes.
],
"agents": {
"defaults": {
"model": "gpt-5.4"
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses agents.defaults.model, but other updated docs in this PR (migration guide + troubleshooting) indicate the key is now agents.defaults.model_name. Update this example (and any nearby text) to use model_name to avoid conflicting configuration guidance.

Suggested change
"model": "gpt-5.4"
"model_name": "gpt-5.4"

Copilot uses AI. Check for mistakes.
],
"agents": {
"defaults": {
"model": "gpt-5.4"
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same inconsistency as the English providers guide: this example should use agents.defaults.model_name if that's the current config key referenced elsewhere in the docs.

Suggested change
"model": "gpt-5.4"
"model_name": "gpt-5.4"

Copilot uses AI. Check for mistakes.
Comment on lines +71 to +79
| 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
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This translation is out of sync with the updated canonical docs/tools_configuration.md: custom_deny_patterns is documented as string[] (not array), and the exec tool now includes additional settings (custom_allow_patterns, allow_remote, timeout_seconds). To avoid misleading users, mirror the updated schema and types here as well.

Suggested change
| 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
| Config | Tipo | Padrão | Descrição |
|-------------------------|----------|--------|----------------------------------------------------------------|
| `enable_deny_patterns` | bool | true | Habilitar bloqueio padrão de comandos perigosos |
| `custom_deny_patterns` | string[] | [] | Padrões de negação personalizados (expressões regulares) |
| `custom_allow_patterns` | string[] | [] | Padrões de permissão personalizados (expressões regulares) |
| `allow_remote` | bool | false | Permitir execução de comandos que envolvem hosts remotos |
| `timeout_seconds` | int | 600 | Tempo máximo de execução de um comando, em segundos |
### 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
- **`custom_allow_patterns`**: Adicione padrões regex de permissão personalizados; comandos correspondentes serão explicitamente permitidos, mesmo se corresponderem a negações genéricas
- **`allow_remote`**: Defina como `true` para permitir comandos que acessem ou controlem recursos remotos (por exemplo, via SSH)
- **`timeout_seconds`**: Defina o limite máximo de tempo de execução de um comando; após esse tempo, o comando será encerrado

Copilot uses AI. Check for mistakes.
Comment on lines +22 to +23
| Sub-arq | Chips típicos | Notas |
|---------|---------------|-------|
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possible typo/abbreviation noise in the table header: consider expanding Sub-arq to Sub-arquitetura for clarity and consistency with Portuguese terminology.

Suggested change
| Sub-arq | Chips típicos | Notas |
|---------|---------------|-------|
| Sub-arquitetura | Chips típicos | Notas |
|-----------------|---------------|-------|

Copilot uses AI. Check for mistakes.
@BeaconCat BeaconCat closed this Mar 20, 2026
@BeaconCat BeaconCat deleted the docs/fix-inaccuracies-and-add-translations branch March 20, 2026 07:02
@BeaconCat BeaconCat reopened this Mar 20, 2026
@sipeed-bot sipeed-bot bot added the type: documentation Improvements or additions to documentation label Mar 20, 2026
Copilot AI review requested due to automatic review settings March 20, 2026 07:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 59 out of 80 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


- Pesquisar na web notícias sobre IA e resumir
- Verificar e-mail e relatar mensagens importantes
```
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a stray closing code fence (), but no corresponding opening fence. This will break Markdown rendering for the remainder of the page. Remove the extraneous (or add the missing opening fence if this section is intended to be a code block).

Suggested change
```

Copilot uses AI. Check for mistakes.
Se você está implantando via Coolify ou Docker, siga estas etapas para testar:

1. **Variáveis de ambiente**:
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This uses PICOCLAW_AGENTS_DEFAULTS_MODEL, but elsewhere in the docs the config key has been migrated to agents.defaults.model_name. To keep env var overrides consistent with the new key name, update this to PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME=... (and apply the same fix in the vi/ja/fr versions of ANTIGRAVITY_USAGE.md where the same line appears).

Suggested change
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
* `PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME=gemini-flash`

Copilot uses AI. Check for mistakes.
| `custom_deny_patterns` | string[] | `[]` | Custom deny patterns (regular expressions) |
| `custom_allow_patterns` | string[] | `[]` | Custom allow patterns that override deny rules |
| `allow_remote` | bool | false | Allow exec tool to be called from remote channels |
| `timeout_seconds` | int | 60 | Command execution timeout in seconds (0 = default 60s) |
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The timeout_seconds row is internally inconsistent: the default is listed as 60, but the description also claims 0 = default 60s. If 0 is a valid sentinel, consider setting the documented default to 0 and clarifying that omitted/0 maps to 60s; otherwise, remove the sentinel note to avoid confusion.

Suggested change
| `timeout_seconds` | int | 60 | Command execution timeout in seconds (0 = default 60s) |
| `timeout_seconds` | int | 60 | Command execution timeout in seconds |

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator

@lxowalle lxowalle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Fixes cross-checked against v0.2.3 codebase:
- MaixCam: server_address → host + port (config.go MaixCamConfig)
- IRC: use_tls → tls, channels_to_join → channels (all languages)
- WeCom AI Bot: port 18791 → 18790 (shared gateway, all languages)
- credential_encryption: base_url → api_base, remove passphrase-only mode (not supported by code)
- migration guide: agents.defaults.model → model_name in "After" example
- troubleshooting: agents.defaults.model → model_name (all languages)
- spawn-tasks: fix truncated file, add Heartbeat introduction
- tools_configuration: add Tavily/SearXNG/GLMSearch, exec allow_remote/timeout_seconds, cron allow_command, skills github/cache
- ANTIGRAVITY_AUTH: fix file path cmd_auth.go → internal/auth/helpers.go, Go >= 1.25
- Matrix links: fix docs/ prefix in relative paths (fr/pt-br/vi)
- configuration: HEARTBEAT.md marked as auto-generated
- README family: add Hardware Compatibility entry to ja/fr/pt-br/vi

New translations (5 languages × 5 docs = 25 files):
- debug.md, credential_encryption.md, hardware-compatibility.md
- ANTIGRAVITY_AUTH.md, ANTIGRAVITY_USAGE.md
- providers.md: agents.defaults.model → model_name (4 occurrences)
- providers.md: remove non-existent session.backlog_limit field
- credential_encryption.md: add required model field to model_list example
- ANTIGRAVITY_AUTH.md: agents.defaults.model → model_name
Config example fixes (synced to all 5 languages):
- providers.md: agents.defaults.model → model_name (4 occurrences per file)
- providers.md: remove non-existent session.backlog_limit field
- credential_encryption.md: add required model field to model_list example
- ANTIGRAVITY_AUTH.md: agents.defaults.model → model_name

Broken link fixes (15 total):
- chat-apps.md: WeCom link docs/channels/ → channels/ (en) or ../channels/ (fr/pt-br/vi)
- providers.md: migration link docs/migration/ → migration/ (en) or ../migration/ (fr/pt-br/vi)
- hardware-compatibility.md: ../README.md → ../../README.{lang}.md (all 5 languages)
- chat-apps.md: WhatsApp dead link → anchor link (zh/ja)
- chat-apps.md: Matrix link channels/ → ../channels/ (fr/pt-br/vi)
- README: add missing `picoclaw model` CLI command (v0.2.3 new)
- README: add comment explaining termux-chroot purpose
- docker.md: clarify first-run only triggers when both config.json and workspace/ are missing
- configuration.md: fix builtin skills path description (build-time embedded, not cwd)
- Sync all 4 fixes to zh/ja/fr/pt-br/vi
…stall

Install section:
- README (all 6 languages): add picoclaw.io as recommended download, GitHub Releases as secondary

QQ channel:
- Add quick setup via q.qq.com/qqbot/openclaw (one-click bot creation)
- Add manual setup as fallback
- Sync to all 6 languages

chat-apps.md:
- Add Feishu, Slack, IRC, OneBot detail sections (all 6 languages)
- Add MaixCam section to ja/fr/pt-br/vi
- Fix all channel doc links to point to correct language version

Channel docs (6 languages each):
- telegram, discord, qq, feishu, maixcam
- dingtalk, line, slack, onebot
- wecom/wecom_aibot, wecom/wecom_app, wecom/wecom_bot
Copilot AI review requested due to automatic review settings March 20, 2026 13:55
@BeaconCat BeaconCat force-pushed the docs/fix-inaccuracies-and-add-translations branch from 2d6fec7 to 20fe265 Compare March 20, 2026 13:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 142 out of 142 changed files in this pull request and generated 9 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 190 to 194
| 配置项 | 类型 | 默认值 | 描述 |
|------------------------|------|--------|-------------------------------------|
| `exec_timeout_minutes` | int | 5 | 执行超时时间(分钟),0 表示无限制 |
| `allow_command` | bool | false | 允许 cron 任务执行 shell 命令 |

Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tools.cron.allow_command is documented with default false, but DefaultConfig() sets AllowCommand: true and config tests assert it defaults to true when unset. Please update the default value to match actual behavior.

Copilot uses AI. Check for mistakes.
Comment on lines +71 to +77
| 配置项 | 类型 | 默认值 | 描述 |
|---------------|--------|--------|-----------------------------------|
| `enabled` | bool | false | 启用 Tavily 搜索 |
| `api_key` | string | - | Tavily API 密钥 |
| `base_url` | string | - | 自定义 Tavily API 基础 URL |
| `max_results` | int | 0 | 最大结果数(0 = 默认) |

Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Tavily max_results default is listed as 0, but the default config initializes tools.web.tavily.max_results to 5 (and runtime falls back to 5 when unset/0). Consider documenting the effective default as 5 and optionally mention that 0 falls back to the default.

Copilot uses AI. Check for mistakes.
Comment on lines +52 to +54
1. **环境变量**:
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
2. **身份验证持久化**:
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses PICOCLAW_AGENTS_DEFAULTS_MODEL=..., but the non-deprecated env var for agents.defaults.model_name is PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME. Consider updating the example (or mention that ..._MODEL is deprecated but still supported).

Copilot uses AI. Check for mistakes.
Comment on lines +52 to +54
1. **Biến môi trường**:
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
2. **Lưu trữ xác thực**:
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses PICOCLAW_AGENTS_DEFAULTS_MODEL=..., but the non-deprecated env var for agents.defaults.model_name is PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME. Consider updating the example (or mention that ..._MODEL is deprecated but still supported).

Copilot uses AI. Check for mistakes.
Comment on lines +52 to +54
1. **環境変数**:
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
2. **認証の永続化**:
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses PICOCLAW_AGENTS_DEFAULTS_MODEL=..., but the non-deprecated env var for agents.defaults.model_name is PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME. Consider updating the example (or mention that ..._MODEL is deprecated but still supported).

Copilot uses AI. Check for mistakes.
Comment on lines 69 to +75
| Config | Type | Default | Description |
|---------------|--------|---------|---------------------------|
| `enabled` | bool | false | Enable Perplexity search |
| `api_key` | string | - | Perplexity API key |
| `max_results` | int | 5 | Maximum number of results |
| `enabled` | bool | false | Enable Tavily search |
| `api_key` | string | - | Tavily API key |
| `base_url` | string | - | Custom Tavily API base URL |
| `max_results` | int | 0 | Maximum number of results (0 = default) |

Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Tavily max_results default is listed as 0, but the default config initializes tools.web.tavily.max_results to 5 (and the web search tool defaults to 5 when the value is unset/0). Consider documenting the effective default as 5 and optionally mention that 0 falls back to the default.

Copilot uses AI. Check for mistakes.
Comment on lines +52 to +54
1. **Variáveis de ambiente**:
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
2. **Persistência da autenticação**:
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses PICOCLAW_AGENTS_DEFAULTS_MODEL=..., but the non-deprecated env var for agents.defaults.model_name is PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME. Consider updating the example (or mention that ..._MODEL is deprecated but still supported).

Copilot uses AI. Check for mistakes.
Comment on lines +52 to +54
1. **Variables d'environnement** :
* `PICOCLAW_AGENTS_DEFAULTS_MODEL=gemini-flash`
2. **Persistance de l'authentification** :
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses PICOCLAW_AGENTS_DEFAULTS_MODEL=..., but the non-deprecated env var for agents.defaults.model_name is PICOCLAW_AGENTS_DEFAULTS_MODEL_NAME. Consider updating the example (or mention that ..._MODEL is deprecated but still supported).

Copilot uses AI. Check for mistakes.
Comment on lines 191 to 195
| Config | Type | Default | Description |
|------------------------|------|---------|------------------------------------------------|
| `exec_timeout_minutes` | int | 5 | Execution timeout in minutes, 0 means no limit |
| `allow_command` | bool | false | Allow cron tasks to execute shell commands |

Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tools.cron.allow_command is documented with default false, but DefaultConfig() sets AllowCommand: true and tests assert it defaults to true when unset. Please update the default value (and any explanation) to match actual behavior.

Copilot uses AI. Check for mistakes.
@BeaconCat
Copy link
Copy Markdown
Contributor Author

Superseded by #1837 — clean single commit rebased on latest main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants