docs: consolidate documentation to en/zh and add docs index
This commit is contained in:
root
parent
65aa1b04f2
commit
d9a9e30876
10 changed files with 145 additions and 4474 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# Contributing to PicoClaw
|
||||
|
||||
Thank you for your interest in contributing to PicoClaw! This project is a community-driven effort to build the lightweight and versatile personal AI assistant. We welcome contributions of all kinds: bug fixes, features, documentation, translations, and testing.
|
||||
Thank you for your interest in contributing to PicoClaw! This project is a community-driven effort to build the lightweight and versatile personal AI assistant. We welcome contributions of all kinds: bug fixes, features, documentation, and testing.
|
||||
|
||||
PicoClaw itself was substantially developed with AI assistance — we embrace this approach and have built our contribution process around it.
|
||||
|
||||
|
|
@ -30,9 +30,11 @@ We are committed to maintaining a welcoming and respectful community. Be kind, c
|
|||
- **Bug reports** — Open an issue using the bug report template.
|
||||
- **Feature requests** — Open an issue using the feature request template; discuss before implementing.
|
||||
- **Code** — Fix bugs or implement features. See the workflow below.
|
||||
- **Documentation** — Improve READMEs, docs, inline comments, or translations.
|
||||
- **Documentation** — Improve READMEs, docs, inline comments, or EN/ZH documentation consistency.
|
||||
- **Testing** — Run PicoClaw on new hardware, channels, or LLM providers and report your results.
|
||||
|
||||
Documentation language policy: English and Chinese only.
|
||||
|
||||
For substantial new features, please open an issue first to discuss the design before writing code. This prevents wasted effort and ensures alignment with the project's direction.
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# 参与贡献 PicoClaw
|
||||
|
||||
感谢你对 PicoClaw 的关注！本项目是一个社区驱动的开源项目，目标是构建 轻量灵活,人人可用 的个人AI助手。我们欢迎一切形式的贡献：Bug 修复、新功能、文档、翻译和测试。
|
||||
感谢你对 PicoClaw 的关注！本项目是一个社区驱动的开源项目，目标是构建 轻量灵活,人人可用 的个人AI助手。我们欢迎一切形式的贡献：Bug 修复、新功能、文档和测试。
|
||||
|
||||
PicoClaw 本身在很大程度上是借助 AI 辅助开发的——我们拥抱这种方式，并围绕它构建了贡献流程。
|
||||
|
||||
|
|
@ -30,9 +30,11 @@ PicoClaw 本身在很大程度上是借助 AI 辅助开发的——我们拥抱
|
|||
- **Bug 反馈** — 使用 Bug 报告模板提交 Issue。
|
||||
- **功能建议** — 使用功能请求模板提交 Issue，建议在开始实现前先进行讨论。
|
||||
- **代码贡献** — 修复 Bug 或实现新功能，参见下方工作流程。
|
||||
- **文档改进** — 完善 README、文档、代码注释或翻译。
|
||||
- **文档改进** — 完善 README、文档、代码注释，或中英文文档一致性。
|
||||
- **测试与验证** — 在新硬件、新渠道或新 LLM 提供商上运行 PicoClaw 并反馈结果。
|
||||
|
||||
文档语言策略：仅维护中文与 English。
|
||||
|
||||
对于较大的新功能，请先提交 Issue 讨论设计方案，再动手写代码。这能避免无效投入，也确保与项目方向保持一致。
|
||||
|
||||
---
|
||||
|
|
|
|||
1146
README.fr.md
1146
README.fr.md
File diff suppressed because it is too large
Load diff
1067
README.ja.md
1067
README.ja.md
File diff suppressed because it is too large
Load diff
11
README.md
11
README.md
|
|
@ -17,7 +17,7 @@
|
|||
<a href="https://discord.gg/V4sAZ9XWpN"><img src="https://img.shields.io/badge/Discord-Community-4c60eb?style=flat&logo=discord&logoColor=white" alt="Discord"></a>
|
||||
</p>
|
||||
|
||||
[中文](README.zh.md) | [日本語](README.ja.md) | [Português](README.pt-br.md) | [Tiếng Việt](README.vi.md) | [Français](README.fr.md) | **English**
|
||||
[中文](README.zh.md) | **English**
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -52,9 +52,16 @@
|
|||
> * **Warning:** picoclaw is in early development now and may have unresolved network security issues. Do not deploy to production environments before the v1.0 release.
|
||||
> * **Note:** picoclaw has recently merged a lot of PRs, which may result in a larger memory footprint (10–20MB) in the latest versions. We plan to prioritize resource optimization as soon as the current feature set reaches a stable state.
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
Use the centralized doc index for faster navigation:
|
||||
|
||||
- English: [docs/README.md](docs/README.md)
|
||||
- 中文: [docs/README.zh.md](docs/README.zh.md)
|
||||
|
||||
## 📢 News
|
||||
|
||||
2026-02-16 🎉 PicoClaw hit 12K stars in one week! Thank you all for your support! PicoClaw is growing faster than we ever imagined. Given the high volume of PRs, we urgently need community maintainers. Our volunteer roles and roadmap are officially posted [here](docs/ROADMAP.md) —we can’t wait to have you on board!
|
||||
2026-02-16 🎉 PicoClaw hit 12K stars in one week! Thank you all for your support! PicoClaw is growing faster than we ever imagined. Given the high volume of PRs, we urgently need community maintainers. Our volunteer roles and roadmap are officially posted [here](ROADMAP.md) —we can’t wait to have you on board!
|
||||
|
||||
2026-02-13 🎉 PicoClaw hit 5000 stars in 4days! Thank you for the community! There are so many PRs & issues coming in (during Chinese New Year holidays), we are finalizing the Project Roadmap and setting up the Developer Group to accelerate PicoClaw's development.
|
||||
🚀 Call to Action: Please submit your feature requests in GitHub Discussions. We will review and prioritize them during our upcoming weekly meeting.
|
||||
|
|
|
|||
1141
README.pt-br.md
1141
README.pt-br.md
File diff suppressed because it is too large
Load diff
1111
README.vi.md
1111
README.vi.md
File diff suppressed because it is too large
Load diff
13
README.zh.md
13
README.zh.md
|
|
@ -14,7 +14,7 @@
|
|||
<a href="https://x.com/SipeedIO"><img src="https://img.shields.io/badge/X_(Twitter)-SipeedIO-black?style=flat&logo=x&logoColor=white" alt="Twitter"></a>
|
||||
</p>
|
||||
|
||||
**中文** | [日本語](README.ja.md) | [Português](README.pt-br.md) | [Tiếng Việt](README.vi.md) | [Français](README.fr.md) | [English](README.md)
|
||||
**中文** | [English](README.md)
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -50,9 +50,16 @@
|
|||
> - **注意:** picoclaw正在初期的快速功能开发阶段，可能有尚未修复的网络安全问题，在1.0正式版发布前，请不要将其部署到生产环境中
|
||||
> - **注意:** picoclaw最近合并了大量PRs，近期版本可能内存占用较大(10~20MB)，我们将在功能较为收敛后进行资源占用优化.
|
||||
|
||||
## 📚 文档导航
|
||||
|
||||
推荐从统一入口快速定位文档：
|
||||
|
||||
- 中文: [docs/README.zh.md](docs/README.zh.md)
|
||||
- English: [docs/README.md](docs/README.md)
|
||||
|
||||
## 📢 新闻 (News)
|
||||
|
||||
2026-02-16 🎉 PicoClaw 在一周内突破了12K star! 感谢大家的关注！PicoClaw 的成长速度超乎我们预期. 由于PR数量的快速膨胀，我们亟需社区开发者参与维护. 我们需要的志愿者角色和roadmap已经发布到了[这里](docs/ROADMAP.md), 期待你的参与！
|
||||
2026-02-16 🎉 PicoClaw 在一周内突破了12K star! 感谢大家的关注！PicoClaw 的成长速度超乎我们预期. 由于PR数量的快速膨胀，我们亟需社区开发者参与维护. 我们需要的志愿者角色和roadmap已经发布到了[这里](ROADMAP.md), 期待你的参与！
|
||||
|
||||
2026-02-13 🎉 **PicoClaw 在 4 天内突破 5000 Stars！** 感谢社区的支持！由于正值中国春节假期，PR 和 Issue 涌入较多，我们正在利用这段时间敲定 **项目路线图 (Roadmap)** 并组建 **开发者群组**，以便加速 PicoClaw 的开发。
|
||||
🚀 **行动号召：** 请在 GitHub Discussions 中提交您的功能请求 (Feature Requests)。我们将在接下来的周会上进行审查和优先级排序。
|
||||
|
|
@ -421,7 +428,7 @@ Agent 读取 HEARTBEAT.md
|
|||
| 提供商 | 用途 | 获取 API Key |
|
||||
| -------------------- | ---------------------------- | -------------------------------------------------------------------- |
|
||||
| `gemini` | LLM (Gemini 直连) | [aistudio.google.com](https://aistudio.google.com) |
|
||||
| `zhipu` | LLM (智谱直连) | [bigmodel.cn](bigmodel.cn) |
|
||||
| `zhipu` | LLM (智谱直连) | [bigmodel.cn](https://bigmodel.cn) |
|
||||
| `openrouter(待测试)` | LLM (推荐，可访问所有模型) | [openrouter.ai](https://openrouter.ai) |
|
||||
| `anthropic(待测试)` | LLM (Claude 直连) | [console.anthropic.com](https://console.anthropic.com) |
|
||||
| `openai(待测试)` | LLM (GPT 直连) | [platform.openai.com](https://platform.openai.com) |
|
||||
|
|
|
|||
59
docs/README.md
Normal file
59
docs/README.md
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
# Documentation Index
|
||||
|
||||
PicoClaw documentation is maintained in **English** and **Chinese** only.
|
||||
|
||||
## 1. Start Here
|
||||
|
||||
| Topic | Document | Language |
|
||||
| --- | --- | --- |
|
||||
| Project overview and quick start | [../README.md](../README.md) | English |
|
||||
| 项目总览与快速开始 | [../README.zh.md](../README.zh.md) | 中文 |
|
||||
| Contribution guide | [../CONTRIBUTING.md](../CONTRIBUTING.md) | English |
|
||||
| 贡献指南 | [../CONTRIBUTING.zh.md](../CONTRIBUTING.zh.md) | 中文 |
|
||||
| Community roadmap | [../ROADMAP.md](../ROADMAP.md) | English |
|
||||
|
||||
## 2. Channels / Messaging Integrations
|
||||
|
||||
Most channel setup docs are currently in Chinese:
|
||||
|
||||
| Channel | Document |
|
||||
| --- | --- |
|
||||
| Telegram | [channels/telegram/README.zh.md](channels/telegram/README.zh.md) |
|
||||
| Discord | [channels/discord/README.zh.md](channels/discord/README.zh.md) |
|
||||
| Slack | [channels/slack/README.zh.md](channels/slack/README.zh.md) |
|
||||
| QQ | [channels/qq/README.zh.md](channels/qq/README.zh.md) |
|
||||
| DingTalk | [channels/dingtalk/README.zh.md](channels/dingtalk/README.zh.md) |
|
||||
| WeCom Bot | [channels/wecom/wecom_bot/README.zh.md](channels/wecom/wecom_bot/README.zh.md) |
|
||||
| WeCom App | [channels/wecom/wecom_app/README.zh.md](channels/wecom/wecom_app/README.zh.md) |
|
||||
| Feishu | [channels/feishu/README.zh.md](channels/feishu/README.zh.md) |
|
||||
| LINE | [channels/line/README.zh.md](channels/line/README.zh.md) |
|
||||
| OneBot | [channels/onebot/README.zh.md](channels/onebot/README.zh.md) |
|
||||
| MaixCam | [channels/maixcam/README.zh.md](channels/maixcam/README.zh.md) |
|
||||
|
||||
## 3. Providers and Tools
|
||||
|
||||
| Topic | Document | Language |
|
||||
| --- | --- | --- |
|
||||
| Antigravity auth and integration | [ANTIGRAVITY_AUTH.md](ANTIGRAVITY_AUTH.md) | English |
|
||||
| Antigravity provider usage | [ANTIGRAVITY_USAGE.md](ANTIGRAVITY_USAGE.md) | English |
|
||||
| Tools configuration | [tools_configuration.md](tools_configuration.md) | English |
|
||||
| 企业微信应用配置详解 | [wecom-app-configuration.md](wecom-app-configuration.md) | 中文 |
|
||||
|
||||
## 4. Architecture and Design
|
||||
|
||||
| Topic | Document | Language |
|
||||
| --- | --- | --- |
|
||||
| Provider architecture refactoring design | [design/provider-refactoring.md](design/provider-refactoring.md) | English |
|
||||
| Provider refactoring test summary | [design/provider-refactoring-tests.md](design/provider-refactoring-tests.md) | English |
|
||||
| Orchestration and audit runtime design | [design/orchestration-audit.md](design/orchestration-audit.md) | English |
|
||||
|
||||
## 5. Migration
|
||||
|
||||
| Topic | Document | Language |
|
||||
| --- | --- | --- |
|
||||
| From `providers` to `model_list` | [migration/model-list-migration.md](migration/model-list-migration.md) | English |
|
||||
|
||||
## 6. Documentation Policy
|
||||
|
||||
- Maintained languages: **English** and **Chinese**
|
||||
- If you add or update major docs, keep EN/ZH navigation discoverable from top-level README files.
|
||||
59
docs/README.zh.md
Normal file
59
docs/README.zh.md
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
# 文档索引
|
||||
|
||||
PicoClaw 当前只维护 **中文** 与 **English** 两种文档语言。
|
||||
|
||||
## 1. 先看这里
|
||||
|
||||
| 主题 | 文档 | 语言 |
|
||||
| --- | --- | --- |
|
||||
| 项目总览与快速开始 | [../README.zh.md](../README.zh.md) | 中文 |
|
||||
| Project overview and quick start | [../README.md](../README.md) | English |
|
||||
| 贡献指南 | [../CONTRIBUTING.zh.md](../CONTRIBUTING.zh.md) | 中文 |
|
||||
| Contribution guide | [../CONTRIBUTING.md](../CONTRIBUTING.md) | English |
|
||||
| 社区路线图 | [../ROADMAP.md](../ROADMAP.md) | English |
|
||||
|
||||
## 2. 渠道接入文档
|
||||
|
||||
当前大部分渠道接入文档为中文：
|
||||
|
||||
| 渠道 | 文档 |
|
||||
| --- | --- |
|
||||
| Telegram | [channels/telegram/README.zh.md](channels/telegram/README.zh.md) |
|
||||
| Discord | [channels/discord/README.zh.md](channels/discord/README.zh.md) |
|
||||
| Slack | [channels/slack/README.zh.md](channels/slack/README.zh.md) |
|
||||
| QQ | [channels/qq/README.zh.md](channels/qq/README.zh.md) |
|
||||
| 钉钉 | [channels/dingtalk/README.zh.md](channels/dingtalk/README.zh.md) |
|
||||
| 企业微信机器人 | [channels/wecom/wecom_bot/README.zh.md](channels/wecom/wecom_bot/README.zh.md) |
|
||||
| 企业微信自建应用 | [channels/wecom/wecom_app/README.zh.md](channels/wecom/wecom_app/README.zh.md) |
|
||||
| 飞书 | [channels/feishu/README.zh.md](channels/feishu/README.zh.md) |
|
||||
| LINE | [channels/line/README.zh.md](channels/line/README.zh.md) |
|
||||
| OneBot | [channels/onebot/README.zh.md](channels/onebot/README.zh.md) |
|
||||
| MaixCam | [channels/maixcam/README.zh.md](channels/maixcam/README.zh.md) |
|
||||
|
||||
## 3. Provider 与工具
|
||||
|
||||
| 主题 | 文档 | 语言 |
|
||||
| --- | --- | --- |
|
||||
| Antigravity 认证与接入 | [ANTIGRAVITY_AUTH.md](ANTIGRAVITY_AUTH.md) | English |
|
||||
| Antigravity 使用说明 | [ANTIGRAVITY_USAGE.md](ANTIGRAVITY_USAGE.md) | English |
|
||||
| 工具配置说明 | [tools_configuration.md](tools_configuration.md) | English |
|
||||
| 企业微信应用配置详解 | [wecom-app-configuration.md](wecom-app-configuration.md) | 中文 |
|
||||
|
||||
## 4. 架构设计
|
||||
|
||||
| 主题 | 文档 | 语言 |
|
||||
| --- | --- | --- |
|
||||
| Provider 架构重构设计 | [design/provider-refactoring.md](design/provider-refactoring.md) | English |
|
||||
| Provider 重构测试总结 | [design/provider-refactoring-tests.md](design/provider-refactoring-tests.md) | English |
|
||||
| 编排与审计运行时设计 | [design/orchestration-audit.md](design/orchestration-audit.md) | English |
|
||||
|
||||
## 5. 迁移指南
|
||||
|
||||
| 主题 | 文档 | 语言 |
|
||||
| --- | --- | --- |
|
||||
| 从 `providers` 迁移到 `model_list` | [migration/model-list-migration.md](migration/model-list-migration.md) | English |
|
||||
|
||||
## 6. 文档维护策略
|
||||
|
||||
- 维护语言仅限：**中文** 与 **English**
|
||||
- 新增或更新核心文档时，请确保在顶层 README 中可被发现
|
||||
Loading…
Add table
Reference in a new issue