A Chinese-language tutorial series for installing, configuring and building your own OpenClaw AI assistant, from beginner setup to custom Skills development.
2.2K231PythonNo licenseUpdated 10 days ago
yeuxuan/openclaw-docs
A Simplified Chinese tutorial site and source walkthrough for OpenClaw, a self-hosted multi-channel AI assistant platform.
- Stars
- 751
- Forks
- 108
- Open issues
- 3
- Last commit
- 14 days ago
What is it?
This repository is a Chinese-language documentation site for OpenClaw, a self-hosted personal AI assistant platform that runs on your own computer or server. OpenClaw uses a Gateway to connect a web control UI, chat channels, mobile nodes, tools and language models.
The site is organized into four tracks: a beginner installation tutorial set, a full engineering walkthrough covering the CLI, Gateway control plane, plugins and channel adapters, an AI core framework track covering context engineering, agent state machines, tool policies, model fallback and memory, and a channel adapter section. It is built with VitePress and includes a local preview workflow via npm scripts.
The documentation covers connections to chat platforms such as WhatsApp, Telegram, Discord, Slack and Feishu, and to model providers such as Claude, GPT, DeepSeek, Qwen and Ollama. It is maintained separately from the official OpenClaw project.
Key features
- 01Beginner installation tutorials covering onboarding, Web control UI, nodes and channel setup
- 02Source-level walkthroughs of the CLI, Gateway, plugins and agent execution flow
- 03AI framework articles on context, agent state machines, tool approval and memory
- 04Setup guides for chat channels including Telegram, WhatsApp, Discord and Feishu
- 05Built with VitePress with local dev, build and preview commands
Use cases
- Setting up a self-hosted OpenClaw assistant for the first time
- Reading the OpenClaw source code to understand its Gateway and channel architecture
- Learning how AI agent frameworks handle context, tools and model fallback
- Configuring Chinese model providers such as DeepSeek or Qwen for OpenClaw
Quick start
- 1
Clone the repository
git clone https://github.com/yeuxuan/openclaw-docs.git - 2
Enter the project folder
cd openclaw-docs - 3
Install dependencies
npm install - 4
Start the local docs site and open the address shown in the terminal
npm run docs:dev
Things to know
- This is an unofficial Simplified Chinese tutorial site, not the official OpenClaw documentation.
- The metadata lists no license, although the README shows an MIT badge, so check the LICENSE file before reuse.
Topics
FAQ
- What is openclaw-docs?
- A Simplified Chinese tutorial site and source walkthrough for OpenClaw, a self-hosted multi-channel AI assistant platform. This repository is a Chinese-language documentation site for OpenClaw, a self-hosted personal AI assistant platform that runs on your own computer or server. OpenClaw uses a Gateway to connect a web control UI, chat channels, mobile nodes, tools and language models.
- Is openclaw-docs free to use? What license does it have?
- openclaw-docs has no declared license. Its code is public, but without a license you have no explicit permission to reuse it; ask the author before relying on it.
- Is openclaw-docs still maintained?
- Actively maintained. The last commit to openclaw-docs was on Oct 8, 2026.
- What can I use openclaw-docs for?
- Setting up a self-hosted OpenClaw assistant for the first time Reading the OpenClaw source code to understand its Gateway and channel architecture Learning how AI agent frameworks handle context, tools and model fallback Configuring Chinese model providers such as DeepSeek or Qwen for OpenClaw
- How do I install openclaw-docs?
- Clone the repository: git clone https://github.com/yeuxuan/openclaw-docs.git Enter the project folder: cd openclaw-docs Install dependencies: npm install Start the local docs site and open the address shown in the terminal: npm run docs:dev
- Where can I get openclaw-docs?
- The source code and installation instructions are on GitHub: https://github.com/yeuxuan/openclaw-docs
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A Chinese-language textbook that teaches you to build a Pi-style coding agent step by step across 15 runnable Git checkpoints in TypeScript.
1.4K83TypeScriptMITUpdated 3 months ago
A Chinese-language book documenting DeepSeek's open-source Harness agent framework, covering its system prompt, default boot manifest, and session logs from hands-on runs.
1.3K117HTMLNo licenseUpdated 2 months ago
A Chinese-language tutorial collection teaching Claude Code, OpenClaw, Codex and WorkBuddy for AI coding, personal agents and office work, with practice materials.
6.3K1.1KPythonMITUpdated 2 days ago
A non-official Chinese learning handbook for the Pi Coding Agent terminal harness, covering setup through Skills, Extensions, Subagents and long-running workflows.
32120MarkdownMITUpdated 11 days ago
A Chinese-language tutorial for learning AstronClaw, a cloud AI assistant, and Loomy, a desktop AI work assistant, from setup to workflows.
35744JavaScriptApache-2.0Updated 10 days ago