From aca47c0ce55a516abf42735061382cd7076082f3 Mon Sep 17 00:00:00 2001 From: Kadic Mirzet Date: Thu, 19 Feb 2026 21:11:48 +0100 Subject: [PATCH] docs: add Full Documentation section to all README translations MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add 📚 Full Documentation section with links to docs/ directory and expand 🤝 Contribute & Roadmap section with roadmap highlights, contribution tracks, and community links. Updated files: - README.md (English) - README.zh.md (Chinese) - README.pt-br.md (Portuguese-Brazil) - README.vi.md (Vietnamese) - README.ja.md (Japanese) Generated with [Z.ai](https://z.ai/subscribe?ic=JGTYCX7ZO7) Co-Authored-By: Z.ai GLM-5 --- README.ja.md | 37 +++++++++++++++++++++++++++++++++++-- README.md | 4 ++++ README.pt-br.md | 45 +++++++++++++++++++++++++++++++++++++++++---- README.vi.md | 45 +++++++++++++++++++++++++++++++++++++++++---- README.zh.md | 45 +++++++++++++++++++++++++++++++++++++++++---- 5 files changed, 162 insertions(+), 14 deletions(-) diff --git a/README.ja.md b/README.ja.md index 7da16565f..bd968b39b 100644 --- a/README.ja.md +++ b/README.ja.md @@ -724,11 +724,44 @@ HEARTBEAT_OK 応答 ユーザーが直接結果を受け取る | `picoclaw gateway` | ゲートウェイを起動 | | `picoclaw status` | ステータスを表示 | +--- + +## 📚 完全なドキュメント + +包括的なガイドとリファレンスについては、[docs/](docs/) ディレクトリをご覧ください： + +- **[はじめに](docs/getting-started/README.md)** - インストールとクイックスタート +- **[ユーザーガイド](docs/user-guide/README.md)** - 完全な機能ドキュメント +- **[開発者ガイド](docs/developer-guide/README.md)** - アーキテクチャとコントリビューション +- **[デプロイ](docs/deployment/README.md)** - Docker、systemd、SBC ガイド +- **[設定リファレンス](docs/configuration/README.md)** - 設定オプションの完全なリファレンス + ## 🤝 コントリビュート＆ロードマップ -PR 歓迎！コードベースは意図的に小さく読みやすくしています。🤗 +### ロードマップハイライト -Discord: https://discord.gg/V4sAZ9XWpN +| 重点分野 | 目標 | +|----------|------| +| **コア最適化** | 64MB RAM デバイスで <20MB メモリで動作 | +| **セキュリティ強化** | プロンプトインジェクション対策、SSRF 保護、サンドボックス | +| **接続性** | プロトコルファーストアーキテクチャ、OneBot 標準対応 | +| **高度機能** | MCP 対応、ブラウザ自動化、マルチエージェント協調 | +| **開発者体験** | ゼロ設定スタート、包括的なドキュメント | + +### コントリビュート + +PR を歓迎します！コードベースは意図的に小さく読みやすくしています。🤗 + +- **高速トラック**: 1 つのマージされた PR で開発者 Discord に参加可能 +- **アプリケーショントラック**: `support@sipeed.com` にメール（件名: `[Apply Join PicoClaw Dev Group] + GitHub アカウント`） + +### コミュニティ + +- **Discord**: https://discord.gg/V4sAZ9XWpN +- **Twitter**: #picoclaw で @SipeedIO をメンション +- **Bilibili**: @Sipeed矽速科技 + +詳細なロードマップについては [ROADMAP.md](ROADMAP.md) をご覧ください。 PicoClaw diff --git a/README.md b/README.md index 0c7de71ec..630b2ed5a 100644 --- a/README.md +++ b/README.md @@ -836,6 +836,8 @@ PicoClaw supports scheduled reminders and recurring tasks through the `cron` too Jobs are stored in `~/.picoclaw/workspace/cron/` and processed automatically. +--- + ## 🤝 Contribute & Roadmap PRs welcome! The codebase is intentionally small and readable. 🤗 @@ -875,6 +877,8 @@ We're looking for contributors in: PicoClaw WeChat +--- + ## 🐛 Troubleshooting ### Web search says "API 配置问题" diff --git a/README.pt-br.md b/README.pt-br.md index fa73465dd..2b2c3b609 100644 --- a/README.pt-br.md +++ b/README.pt-br.md @@ -817,17 +817,54 @@ O PicoClaw suporta lembretes agendados e tarefas recorrentes por meio da ferrame As tarefas são armazenadas em `~/.picoclaw/workspace/cron/` e processadas automaticamente. +--- + +## 📚 Documentação Completa + +Para guias e referências abrangentes, consulte o diretório [docs/](docs/): + +- **[Primeiros Passos](docs/getting-started/README.md)** - Instalação e início rápido +- **[Guia do Usuário](docs/user-guide/README.md)** - Documentação completa de recursos +- **[Guia do Desenvolvedor](docs/developer-guide/README.md)** - Arquitetura e contribuição +- **[Implantação](docs/deployment/README.md)** - Guias Docker, systemd, SBC +- **[Referência de Configuração](docs/configuration/README.md)** - Referência completa de opções de configuração + ## 🤝 Contribuir & Roadmap PRs são bem-vindos! O código-fonte é intencionalmente pequeno e legível. 🤗 -Roadmap em breve... +### Destaques do Roadmap -Grupo de desenvolvedores em formação. Requisito de entrada: Pelo menos 1 PR com merge. +| Área de Foco | Metas | +|-------------|-------| +| **Otimização Principal** | Rodar em dispositivos de 64MB RAM com <20MB de memória | +| **Endurecimento de Segurança** | Sandbox, OAuth 2.0, defesa contra injeção de prompt | +| **Conectividade** | Mais canais, suporte MCP, marketplace de skills | +| **Multi-Agentes** | Roteamento de modelos, modo swarm, integração AIEOS | +| **Experiência do Desenvolvedor** | Assistente CLI interativo, documentação completa | -Grupos de usuários: +Veja o [Roadmap Completo](ROADMAP.md) e [Roadmap da Comunidade](docs/picoclaw_community_roadmap_260216.md) para detalhes. -Discord: +### Funções de Voluntário + +Estamos procurando contribuidores em: +- **Revisores de Issue/PR** - Ajudar a triar e merge PRs +- **Otimização de Recursos** - Manter o PicoClaw leve +- **Auditoria de Segurança** - Revisar e fortalecer a segurança +- **Documentação** - Melhorar guias e tutoriais +- **Automação CI/CD** - Builds e triagem de issues com IA + +**Benefícios:** Hardware de IA exclusivo, descontos em tokens e mais! + +### Como Participar + +1. **Via Rápida**: Mergear 1+ PR → Entrar no Discord de Desenvolvedores +2. **Candidatura**: Email para support@sipeed.com com `[Apply: PicoClaw Expert Volunteer]` + +### Comunidade + +- **Discord**: +- **GitHub Discussions**: Compartilhe ideias e solicitações de recursos PicoClaw diff --git a/README.vi.md b/README.vi.md index e629eaa9b..f7a1ebc7c 100644 --- a/README.vi.md +++ b/README.vi.md @@ -794,17 +794,54 @@ PicoClaw hỗ trợ nhắc nhở theo lịch và tác vụ lặp lại thông qu Các tác vụ được lưu trong `~/.picoclaw/workspace/cron/` và được xử lý tự động. +--- + +## 📚 Tài liệu Đầy đủ + +Để có hướng dẫn và tài liệu tham khảo đầy đủ, xem thư mục [docs/](docs/): + +- **[Bắt đầu](docs/getting-started/README.md)** - Cài đặt và bắt đầu nhanh +- **[Hướng dẫn Người dùng](docs/user-guide/README.md)** - Tài liệu tính năng đầy đủ +- **[Hướng dẫn Nhà phát triển](docs/developer-guide/README.md)** - Kiến trúc và đóng góp +- **[Triển khai](docs/deployment/README.md)** - Hướng dẫn Docker, systemd, SBC +- **[Tham khảo Cấu hình](docs/configuration/README.md)** - Tài liệu tham khảo đầy đủ về cấu hình + ## 🤝 Đóng góp & Lộ trình Chào đón mọi PR! Mã nguồn được thiết kế nhỏ gọn và dễ đọc. 🤗 -Lộ trình sắp được công bố... +### Tóm tắt Lộ trình -Nhóm phát triển đang được xây dựng. Điều kiện tham gia: Ít nhất 1 PR đã được merge. +| Lĩnh vực trọng tâm | Mục tiêu | +|-------------------|----------| +| **Tối ưu hóa Core** | Chạy trên thiết bị 64MB RAM với <20MB bộ nhớ | +| **Tăng cường Bảo mật** | Sandbox, OAuth 2.0, phòng chống prompt injection | +| **Kết nối** | Thêm kênh, hỗ trợ MCP, marketplace skill | +| **Multi-Agent** | Định tuyến mô hình, chế độ swarm, tích hợp AIEOS | +| **Trải nghiệm Dev** | Trợ lý CLI tương tác, tài liệu đầy đủ | -Nhóm người dùng: +Xem [Lộ trình Đầy đủ](ROADMAP.md) và [Lộ trình Cộng đồng](docs/picoclaw_community_roadmap_260216.md) để biết chi tiết. -Discord: +### Vai trò Tình nguyện viên + +Chúng tôi đang tìm kiếm người đóng góp trong: +- **Người xem xét Issue/PR** - Giúp phân loại và merge PR +- **Tối ưu hóa Tài nguyên** - Giữ PicoClaw nhẹ nhàng +- **Kiểm toán Bảo mật** - Xem xét và tăng cường bảo mật +- **Tài liệu** - Cải thiện hướng dẫn và tutorial +- **Tự động hóa CI/CD** - Build và xử lý issue với AI + +**Quyền lợi:** Phần cứng AI độc quyền, giảm giá token và hơn thế! + +### Cách Tham gia + +1. **Đường nhanh**: Merge 1+ PR → Tham gia Discord Nhà phát triển +2. **Ứng tuyển**: Email support@sipeed.com với `[Apply: PicoClaw Expert Volunteer]` + +### Cộng đồng + +- **Discord**: +- **GitHub Discussions**: Chia sẻ ý tưởng và yêu cầu tính năng PicoClaw diff --git a/README.zh.md b/README.zh.md index 42bd20be4..119eeb3c6 100644 --- a/README.zh.md +++ b/README.zh.md @@ -684,17 +684,54 @@ PicoClaw 通过 `cron` 工具支持定时提醒和重复任务： 任务存储在 `~/.picoclaw/workspace/cron/` 中并自动处理。 +--- + +## 📚 完整文档 + +如需完整的指南和参考，请查看 [docs/](docs/) 目录： + +- **[入门指南](docs/getting-started/README.md)** - 安装和快速开始 +- **[用户指南](docs/user-guide/README.md)** - 完整功能文档 +- **[开发者指南](docs/developer-guide/README.md)** - 架构和贡献 +- **[部署指南](docs/deployment/README.md)** - Docker、systemd、SBC 指南 +- **[配置参考](docs/configuration/README.md)** - 完整配置选项参考 + ## 🤝 贡献与路线图 (Roadmap) 欢迎提交 PR！代码库刻意保持小巧和可读。🤗 -路线图即将发布... +### 路线图概要 -开发者群组正在组建中，入群门槛：至少合并过 1 个 PR。 +| 重点领域 | 目标 | +|---------|------| +| **核心优化** | 在 64MB 内存设备上运行，占用 <20MB | +| **安全加固** | 沙盒、OAuth 2.0、提示注入防御 | +| **连接性** | 更多频道、MCP 支持、技能市场 | +| **多智能体** | 模型路由、集群模式、AIEOS 集成 | +| **开发者体验** | 交互式 CLI 向导、完善文档 | -用户群组： +详见 [完整路线图](ROADMAP.md) 和 [社区路线图](docs/picoclaw_community_roadmap_260216.md)。 -Discord: [https://discord.gg/V4sAZ9XWpN](https://discord.gg/V4sAZ9XWpN) +### 志愿者角色 + +我们正在寻找以下领域的贡献者： +- **Issue/PR 审核者** - 协助分类和合并 PR +- **资源优化** - 保持 PicoClaw 轻量级 +- **安全审计** - 审查和加固安全性 +- **文档** - 改进指南和教程 +- **CI/CD 自动化** - AI 驱动的构建和问题分流 + +**福利：** 专属 AI 硬件、Token 折扣等！ + +### 如何加入 + +1. **快速通道**：合并 1+ PR → 加入开发者 Discord +2. **申请**：发送邮件至 support@sipeed.com，标题 `[Apply: PicoClaw Expert Volunteer]` + +### 社区 + +- **Discord**: [https://discord.gg/V4sAZ9XWpN](https://discord.gg/V4sAZ9XWpN) +- **GitHub Discussions**: 分享想法和功能请求 PicoClaw