From cce4bb484c6dff01ea6af6186180d8c56b6744cd Mon Sep 17 00:00:00 2001 From: Kadic Mirzet Date: Sat, 21 Feb 2026 12:20:45 +0100 Subject: [PATCH] docs: add Community link to Full Documentation section - Create docs/user-guide/README.md as overview page - Add Community link to all README translations: - README.md (English) - README.zh.md (Chinese) - README.pt-br.md (Portuguese) - README.vi.md (Vietnamese) - README.ja.md (Japanese) - README.fr.md (French) Generated with [Z.ai](https://z.ai/subscribe?ic=JGTYCX7ZO7) Co-Authored-By: Z.ai GLM-5 --- README.fr.md | 1 + README.ja.md | 7 ++-- README.md | 7 ++-- README.pt-br.md | 7 ++-- README.vi.md | 7 ++-- README.zh.md | 7 ++-- docs/user-guide/README.md | 79 +++++++++++++++++++++++++++++++++++++++ 7 files changed, 100 insertions(+), 15 deletions(-) create mode 100644 docs/user-guide/README.md diff --git a/README.fr.md b/README.fr.md index 9c06b8e8c..ff0130e82 100644 --- a/README.fr.md +++ b/README.fr.md @@ -1073,6 +1073,7 @@ Pour des guides et références complets, consultez le répertoire [docs/](docs/ - **[Guide Développeur](docs/developer-guide/README.md)** - Architecture et contribution - **[Déploiement](docs/deployment/README.md)** - Docker, systemd, guides SBC - **[Référence Configuration](docs/configuration/README.md)** - Référence complète des options +- **[Communauté](docs/community/README.md)** - Feuille de route, contribution, support ## 🤝 Contribuer & Feuille de Route diff --git a/README.ja.md b/README.ja.md index 26e553681..21d6afe21 100644 --- a/README.ja.md +++ b/README.ja.md @@ -85,9 +85,9 @@ ### 🐜 革新的な省フットプリントデプロイ PicoClaw はほぼすべての Linux デバイスにデプロイできます！ -- $9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(Ethernet) または W(WiFi6) バージョン、最小ホームアシスタントに -- $30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html) または $100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) サーバー自動メンテナンスに -- $50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) または $100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) スマート監視に +- \$9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(Ethernet) または W(WiFi6) バージョン、最小ホームアシスタントに +- \$30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html) または \$100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) サーバー自動メンテナンスに +- \$50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) または \$100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) スマート監視に https://private-user-images.githubusercontent.com/83055338/547056448-e7b031ff-d6f5-4468-bcca-5726b6fecb5c.mp4 @@ -980,6 +980,7 @@ HEARTBEAT_OK 応答 ユーザーが直接結果を受け取る - **[開発者ガイド](docs/developer-guide/README.md)** - アーキテクチャとコントリビューション - **[デプロイ](docs/deployment/README.md)** - Docker、systemd、SBC ガイド - **[設定リファレンス](docs/configuration/README.md)** - 設定オプションの完全なリファレンス +- **[コミュニティ](docs/community/README.md)** - ロードマップ、コントリビュート、サポート ## 🤝 コントリビュート＆ロードマップ diff --git a/README.md b/README.md index 9a40da7ab..b40736c84 100644 --- a/README.md +++ b/README.md @@ -117,9 +117,9 @@ And then follow the instructions in the "Quick Start" section to complete the co PicoClaw can be deployed on almost any Linux device! -- $9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(Ethernet) or W(WiFi6) version, for Minimal Home Assistant -- $30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), or $100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) for Automated Server Maintenance -- $50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) or $100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) for Smart Monitoring +- \$9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(Ethernet) or W(WiFi6) version, for Minimal Home Assistant +- \$30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), or \$100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) for Automated Server Maintenance +- \$50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) or \$100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) for Smart Monitoring @@ -136,6 +136,7 @@ For comprehensive guides and references, see the [docs/](docs/) directory: - **[Deployment](docs/deployment/README.md)** - Docker, systemd, SBC guides - **[Configuration Reference](docs/configuration/config-file.md)** - All config options - **[Troubleshooting](docs/operations/troubleshooting.md)** - Common issues and solutions +- **[Community](docs/community/README.md)** - Roadmap, contributing, support --- diff --git a/README.pt-br.md b/README.pt-br.md index 116ffae51..9350eab62 100644 --- a/README.pt-br.md +++ b/README.pt-br.md @@ -124,9 +124,9 @@ Depois siga as instruções na seção "Início Rápido" para completar a config O PicoClaw pode ser implantado em praticamente qualquer dispositivo Linux! -- $9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) versão E (Ethernet) ou W (WiFi6), para Assistente Doméstico Minimalista -- $30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), ou $100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) para Manutenção Automatizada de Servidores -- $50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) ou $100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) para Monitoramento Inteligente +- \$9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) versão E (Ethernet) ou W (WiFi6), para Assistente Doméstico Minimalista +- \$30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), ou \$100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html) para Manutenção Automatizada de Servidores +- \$50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) ou \$100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera) para Monitoramento Inteligente https://private-user-images.githubusercontent.com/83055338/547056448-e7b031ff-d6f5-4468-bcca-5726b6fecb5c.mp4 @@ -1067,6 +1067,7 @@ Para guias e referências abrangentes, consulte o diretório [docs/](docs/): - **[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 +- **[Comunidade](docs/community/README.md)** - Roadmap, contribuição, suporte ## 🤝 Contribuir & Roadmap diff --git a/README.vi.md b/README.vi.md index 5823a517e..e19555c8f 100644 --- a/README.vi.md +++ b/README.vi.md @@ -104,9 +104,9 @@ PicoClaw có thể triển khai trên hầu hết mọi thiết bị Linux! -* $9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) phiên bản E (Ethernet) hoặc W (WiFi6), dùng làm Trợ lý Gia đình tối giản. -* $30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), hoặc $100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html), dùng cho quản trị Server tự động. -* $50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) hoặc $100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera), dùng cho Giám sát thông minh. +* \$9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) phiên bản E (Ethernet) hoặc W (WiFi6), dùng làm Trợ lý Gia đình tối giản. +* \$30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html), hoặc \$100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html), dùng cho quản trị Server tự động. +* \$50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) hoặc \$100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera), dùng cho Giám sát thông minh. https://private-user-images.githubusercontent.com/83055338/547056448-e7b031ff-d6f5-4468-bcca-5726b6fecb5c.mp4 @@ -1038,6 +1038,7 @@ Các tác vụ được lưu trong `~/.picoclaw/workspace/cron/` và được x - **[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 +- **[Cộng đồng](docs/community/README.md)** - Lộ trình, đóng góp, hỗ trợ ## 🤝 Đóng góp & Lộ trình diff --git a/README.zh.md b/README.zh.md index 3a78fadd8..70a4398df 100644 --- a/README.zh.md +++ b/README.zh.md @@ -121,9 +121,9 @@ termux-chroot ./picoclaw-linux-arm64 onboard PicoClaw 几乎可以部署在任何 Linux 设备上！ -* $9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(网口) 或 W(WiFi6) 版本，用于极简家庭助手。 -* $30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html)，或 $100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html)，用于自动化服务器运维。 -* $50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) 或 $100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera)，用于智能监控。 +* \$9.9 [LicheeRV-Nano](https://www.aliexpress.com/item/1005006519668532.html) E(网口) 或 W(WiFi6) 版本，用于极简家庭助手。 +* \$30~50 [NanoKVM](https://www.aliexpress.com/item/1005007369816019.html)，或 \$100 [NanoKVM-Pro](https://www.aliexpress.com/item/1005010048471263.html)，用于自动化服务器运维。 +* \$50 [MaixCAM](https://www.aliexpress.com/item/1005008053333693.html) 或 \$100 [MaixCAM2](https://www.kickstarter.com/projects/zepan/maixcam2-build-your-next-gen-4k-ai-camera)，用于智能监控。 [https://private-user-images.githubusercontent.com/83055338/547056448-e7b031ff-d6f5-4468-bcca-5726b6fecb5c.mp4](https://private-user-images.githubusercontent.com/83055338/547056448-e7b031ff-d6f5-4468-bcca-5726b6fecb5c.mp4) @@ -984,6 +984,7 @@ PicoClaw 通过 `cron` 工具支持定时提醒和重复任务： - **[开发者指南](docs/developer-guide/README.md)** - 架构和贡献 - **[部署指南](docs/deployment/README.md)** - Docker、systemd、SBC 指南 - **[配置参考](docs/configuration/README.md)** - 完整配置选项参考 +- **[社区](docs/community/README.md)** - 路线图、贡献、支持 ## 🤝 贡献与路线图 (Roadmap) diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md new file mode 100644 index 000000000..47dda824e --- /dev/null +++ b/docs/user-guide/README.md @@ -0,0 +1,79 @@ +# User Guide + +Complete documentation for using PicoClaw features. + +## Topics + +### CLI Reference + +- [CLI Overview](cli-reference.md) - All commands and options + +### Channels + +Chat platform integrations. + +- [Channels Overview](channels/README.md) - Supported platforms +- [Telegram](channels/telegram.md) - Telegram bot setup +- [Discord](channels/discord.md) - Discord bot setup +- [Slack](channels/slack.md) - Slack integration +- [WeCom](channels/wecom.md) - WeCom (Enterprise WeChat) +- [And more...](channels/README.md) + +### Providers + +LLM provider configuration. + +- [Providers Overview](providers/README.md) - All supported providers +- [OpenRouter](providers/openrouter.md) - Multi-model access +- [Anthropic](providers/anthropic.md) - Claude models +- [Ollama](providers/ollama.md) - Local models +- [And more...](providers/README.md) + +### IDE Setup + +IDE integrations for free AI access. + +- [IDE Setup Overview](ide-setup/README.md) +- [Antigravity](ide-setup/antigravity.md) - Google Cloud Code Assist + +### Workspace + +Customizing agent behavior. + +- [Workspace Overview](workspace/README.md) +- [AGENT.md](workspace/agent-md.md) - Behavior customization +- [Memory](workspace/memory.md) - Long-term memory +- [Heartbeat Tasks](workspace/heartbeat-tasks.md) - Periodic tasks + +### Tools + +Available tools and capabilities. + +- [Tools Overview](tools/README.md) +- [File System](tools/filesystem.md) - read_file, write_file +- [Exec](tools/exec.md) - Shell commands +- [Web](tools/web.md) - web_search, web_fetch +- [Messaging](tools/messaging.md) - Send messages +- [Spawn](tools/spawn.md) - Subagents +- [Cron](tools/cron.md) - Scheduled tasks + +### Skills + +Skills system for extending capabilities. + +- [Skills Overview](skills/README.md) +- [Using Skills](skills/using-skills.md) +- [Installing Skills](skills/installing-skills.md) +- [Creating Skills](skills/creating-skills.md) + +### Advanced Features + +Advanced configuration and multi-agent setups. + +- [Multi-Agent System](advanced/multi-agent.md) +- [Message Routing](advanced/routing.md) +- [Session Management](advanced/session-management.md) +- [Model Fallbacks](advanced/model-fallbacks.md) +- [Security Sandbox](advanced/security-sandbox.md) +- [Environment Variables](advanced/environment-variables.md) +- [Voice Transcription](advanced/voice-transcription.md)