mirror of
https://github.com/openclaw/clawhub.git
synced 2026-08-14 08:52:21 +00:00
Patrick Erichsen
fdb4d312f4
* Revert "fix: serve docs subdomain root (#2630)" This reverts commit9ef33726b8. * Revert "feat: move docs to canonical subdomain" This reverts commit6afb91b772. * Revert "docs: serve ClawHub docs with shared OpenClaw renderer (#2609)" This reverts commit71156751ff. * fix: restore ClawHub email docs host * test: preserve non-docs validation fixes * test: remove stale docs proxy test * docs: keep ClawHub contributor references current * fix: keep docs auth callback outside docs routes
2.3 KiB
2.3 KiB
summary, read_when
| 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/auth.md: GitHub OAuth, API tokens, and CLI login.docs/telemetry.md: install telemetry 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: reporting ClawHub security issues and vulnerability disclosure policy.docs/security-audits.md: user-facing security audit status, risk levels, findings, and interpretation.docs/moderation.md: reports, moderation holds, hidden listings, bans, and account standing.
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.