5b63d5df60
Some checks failed
CI / static (push) Has been cancelled
CI / unit (push) Has been cancelled
CI / packages (push) Has been cancelled
CI / types-build (push) Has been cancelled
CI / e2e-http (push) Has been cancelled
CI / playwright-smoke (push) Has been cancelled
OpenClaw Docs Sync Dispatch / dispatch-openclaw-docs-sync (push) Has been cancelled
Security Gate: Secret Scanning / Scan for Verified Secrets (push) Has been cancelled
Harden skill owner migration across UI, CLI, API, stats, backups, and docs. Co-authored-by: momothemage <niuzhengnan@163.com> |
||
|---|---|---|
| .. | ||
| screenshots/markdown-html-passthrough | ||
| acceptable-usage.md | ||
| api.md | ||
| auth.md | ||
| clawhub.md | ||
| cli.md | ||
| how-it-works.md | ||
| http-api.md | ||
| publishing.md | ||
| quickstart.md | ||
| README.md | ||
| security.md | ||
| skill-format.md | ||
| soul-format.md | ||
| telemetry.md | ||
| troubleshooting.md | ||
| summary | read_when | ||
|---|---|---|---|
| Public ClawHub docs index and reading order. |
|
Docs
docs/ is the publishable source for user-facing ClawHub pages that can be
mirrored into the ClawHub tab on docs.openclaw.ai.
Keep product, CLI, publisher, API, policy, security, and troubleshooting docs here. These pages should explain how people use ClawHub: discover, install, publish, inspect, report, moderate, and integrate with the registry.
Use specs/ for repository setup, production deploy runbooks, implementation
plans, design rationale, regression notes, maintainer validation records, and
internal subsystem intent. If a page tells someone how to run or deploy the
ClawHub project itself, it belongs in specs/, not in the public OpenClaw docs
tab.
Reading order:
docs/clawhub.md: public overview for discovery, install, publish, and trust.docs/quickstart.md: product quickstart for users and publishers.docs/how-it-works.md: listings, versions, installs, publishing, scans, and API access.docs/publishing.md: owner-scoped skill/plugin publishing flow.docs/cli.md: ClawHub CLI reference.docs/skill-format.md: skill bundle metadata and package shape.docs/soul-format.md: SOUL.md bundle format.docs/auth.md: GitHub OAuth, API tokens, and CLI login.docs/telemetry.md: whatclawhub syncreports and how to opt out.docs/troubleshooting.md: user-facing CLI, install, publish, sync, update, and API fixes.
Policy, API, and trust docs:
docs/acceptable-usage.md: marketplace policy and enforcement boundaries.docs/api.md: public REST API overview.docs/http-api.md: detailed HTTP API reference.docs/security.md: moderation, reporting, bans, upload gating, and scan outcomes.
Maintainer records:
specs/README.md: index for specs, plans, deployment runbooks, webhook notes, regression notes, and design records.
Publish flow:
- Changes under
docs/dispatch the OpenClaw docs sync workflow, which mirrors this directory into theClawHubtab ondocs.openclaw.ai. specs/is intentionally not mirrored.