|
|
||
|---|---|---|
| .. | ||
| assets | ||
| contributing | ||
| hardware | ||
| i18n | ||
| maintainers | ||
| ops | ||
| reference | ||
| security | ||
| setup-guides | ||
| vi | ||
| README.fr.md | ||
| README.ja.md | ||
| README.md | ||
| README.ru.md | ||
| README.vi.md | ||
| README.zh-CN.md | ||
| SUMMARY.fr.md | ||
| SUMMARY.ja.md | ||
| SUMMARY.md | ||
| SUMMARY.ru.md | ||
| SUMMARY.zh-CN.md | ||
ZeroClaw Documentation Hub
This page is the primary entry point for the documentation system.
Last refreshed: February 21, 2026.
Localized hubs: 简体中文 · 日本語 · Русский · Français · Tiếng Việt.
Start Here
| I want to… | Read this |
|---|---|
| Install and run ZeroClaw quickly | README.md (Quick Start) |
| Bootstrap in one command | one-click-bootstrap.md |
| Update or uninstall on macOS | macos-update-uninstall.md |
| Find commands by task | commands-reference.md |
| Check config defaults and keys quickly | config-reference.md |
| Configure custom providers/endpoints | custom-providers.md |
| Configure Z.AI / GLM provider | zai-glm-setup.md |
| Use LangGraph integration patterns | langgraph-integration.md |
| Operate runtime (day-2 runbook) | operations-runbook.md |
| Troubleshoot install/runtime/channel issues | troubleshooting.md |
| Run Matrix encrypted-room setup and diagnostics | matrix-e2ee-guide.md |
| Browse docs by category | SUMMARY.md |
| See project PR/issue docs snapshot | project-triage-snapshot-2026-02-18.md |
Quick Decision Tree (10 seconds)
- Need first-time setup or install? → setup-guides/README.md
- Need exact CLI/config keys? → reference/README.md
- Need production/service operations? → ops/README.md
- Seeing failures or regressions? → troubleshooting.md
- Working on security hardening or roadmap? → security/README.md
- Working with boards/peripherals? → hardware/README.md
- Contributing/reviewing/CI workflow? → contributing/README.md
- Want the full map? → SUMMARY.md
Collections (Recommended)
- Getting started: setup-guides/README.md
- Reference catalogs: reference/README.md
- Operations & deployment: ops/README.md
- Security docs: security/README.md
- Hardware/peripherals: hardware/README.md
- Contributing/CI: contributing/README.md
- Project snapshots: maintainers/README.md
By Audience
Users / Operators
- commands-reference.md — command lookup by workflow
- providers-reference.md — provider IDs, aliases, credential env vars
- channels-reference.md — channel capabilities and setup paths
- matrix-e2ee-guide.md — Matrix encrypted-room (E2EE) setup and no-response diagnostics
- config-reference.md — high-signal config keys and secure defaults
- custom-providers.md — custom provider/base URL integration templates
- zai-glm-setup.md — Z.AI/GLM setup and endpoint matrix
- langgraph-integration.md — fallback integration for model/tool-calling edge cases
- operations-runbook.md — day-2 runtime operations and rollback flow
- troubleshooting.md — common failure signatures and recovery steps
Contributors / Maintainers
Security / Reliability
Note: this area includes proposal/roadmap docs. For current behavior, start with config-reference.md, operations-runbook.md, and troubleshooting.md.
- security/README.md
- agnostic-security.md
- frictionless-security.md
- sandboxing.md
- audit-logging.md
- resource-limits.md
- security-roadmap.md
System Navigation & Governance
- Unified TOC: SUMMARY.md
- Docs structure map (language/part/function): structure/README.md
- Documentation inventory/classification: docs-inventory.md
- i18n docs index: i18n/README.md
- i18n coverage map: i18n-coverage.md
- Project triage snapshot: project-triage-snapshot-2026-02-18.md