Skip to content

fix: correct documentation misalignment across translations and guides#537

Merged
yinwm merged 1 commit intosipeed:mainfrom
Esubaalew:main
Feb 20, 2026
Merged

fix: correct documentation misalignment across translations and guides#537
yinwm merged 1 commit intosipeed:mainfrom
Esubaalew:main

Conversation

@Esubaalew
Copy link
Contributor

Fixes inconsistencies between the main README, translated READMEs, and docs/ guides.

  • Translated READMEs (fr, pt-br, vi, ja) used deprecated providers config format instead of model_list
  • fr and pt-br had allowFrom (camelCase) instead of allow_from
  • ja had camelCase keys (apiKey, appId, etc.) in its full config example
  • zh and ja used the old flat web.search config instead of brave/duckduckgo
  • ANTIGRAVITY_AUTH.md referenced OpenClaw project name, TypeScript plugin system, and wrong file paths throughout
  • ANTIGRAVITY_USAGE.md had wrong auth file path and an outdated branch reference
  • tools_configuration.md documented a non-existent approval tool and was missing skills tool docs
  • DingTalk section in main README said "QQ numbers" (copy-paste from QQ section above)
  • Anthropic vendor example showed auth_method: "oauth" but code uses paste-token auth
  • Migration guide was missing several supported protocol prefixes
  • Minor typos in community roadmap

No code changes. All fixes are documentation-only.

- Fix DingTalk section referencing "QQ numbers" instead of DingTalk user IDs
- Fix Anthropic example showing OAuth when code uses paste-token auth
- Replace OpenClaw references in ANTIGRAVITY_AUTH.md with actual PicoClaw paths and Go patterns
- Fix auth file path from auth-profiles.json to auth.json in ANTIGRAVITY_USAGE.md
- Remove non-existent approval tool from tools_configuration.md, add skills tool docs
- Update Quick Start configs in fr/pt-br/vi/ja translations to use model_list format
- Fix allowFrom camelCase to allow_from in fr/pt-br translations
- Fix camelCase config keys in ja translation
- Update zh/ja web search config from old flat format to brave/duckduckgo
- Fix broken ClawdChat link and trailing commas in zh translation
- Add missing qwen/cerebras providers to fr/pt-br/vi translation tables
- Add missing protocol prefixes to migration guide
- Fix typos in community roadmap
Copilot AI review requested due to automatic review settings February 20, 2026 15:25
Copy link
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 pull request fixes numerous documentation inconsistencies across translated READMEs, guides, and configuration examples. The changes align documentation with the actual codebase implementation, particularly around configuration formats, authentication methods, and project naming.

Changes:

  • Migrated all translated READMEs from deprecated providers config to model_list format with protocol prefixes
  • Fixed camelCase configuration keys (allowFrom, apiKey, etc.) to snake_case (allow_from, api_key) across all translations
  • Corrected web tools configuration from old flat web.search to new nested brave/duckduckgo structure
  • Updated ANTIGRAVITY_AUTH.md with comprehensive corrections: OpenClaw → PicoClaw project name, TypeScript → Go code examples, and corrected file paths
  • Fixed tools_configuration.md to document actual skills tool instead of non-existent approval tool
  • Added missing protocol prefixes (gemini, zhipu, nvidia, ollama, vllm, moonshot, shengsuanyun, volcengine) to migration guide
  • Corrected Anthropic authentication method from OAuth to paste-token
  • Fixed minor typos in community roadmap and corrected DingTalk section text in main README

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/tools_configuration.md Removed non-existent approval tool documentation, added skills tool with ClawHub registry configuration
docs/picoclaw_community_roadmap_260216.md Fixed typos: "openclaw/skills" → "ClawhHub", "Model-Agnet" → "Model-Agent"
docs/migration/model-list-migration.md Added missing protocol prefixes: gemini, zhipu, nvidia, ollama, vllm, moonshot, shengsuanyun, volcengine
docs/design/provider-refactoring-tests.md Updated test file paths to match actual structure
docs/ANTIGRAVITY_USAGE.md Fixed auth file path from auth-profiles.json to auth.json, removed outdated branch reference
docs/ANTIGRAVITY_AUTH.md Comprehensive rewrite: OpenClaw → PicoClaw, TypeScript → Go examples, corrected all file paths and config structure
README.zh.md Fixed web config from flat search to nested brave/duckduckgo, corrected JSON syntax
README.vi.md Migrated from providers to model_list format, simplified example config
README.pt-br.md Migrated from providers to model_list, fixed allowFromallow_from, added cerebras info
README.md Fixed DingTalk section ("QQ numbers" → "DingTalk user IDs"), corrected Anthropic auth example (oauth → api_key)
README.ja.md Migrated from providers to model_list, fixed all camelCase keys to snake_case, updated web config
README.fr.md Migrated from providers to model_list, fixed allowFromallow_from, added qwen/cerebras info

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

@yinwm yinwm merged commit e23795e into sipeed:main Feb 20, 2026
7 of 8 checks passed
@yinwm
Copy link
Collaborator

yinwm commented Feb 20, 2026

thanks for this PR

hyperwd pushed a commit to hyperwd/picoclaw that referenced this pull request Mar 5, 2026
fix: correct documentation misalignment across translations and guides
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants