4ae0406948
* refactor: rename internal clawdhub package path * fix: update workflow paths after clawhub dir rename * fix: preserve old tag npm release compatibility --------- Co-authored-by: Onur <onur@solmaz.io> |
||
|---|---|---|
| .. | ||
| plans | ||
| acceptable-usage.md | ||
| api.md | ||
| architecture.md | ||
| auth.md | ||
| cli.md | ||
| deploy.md | ||
| diffing.md | ||
| github-import.md | ||
| http-api.md | ||
| manual-testing.md | ||
| mintlify.md | ||
| orgs.md | ||
| quickstart.md | ||
| README.md | ||
| security.md | ||
| skill-format.md | ||
| soul-format.md | ||
| spec.md | ||
| telemetry.md | ||
| troubleshooting.md | ||
| webhook.md | ||
| summary | read_when | ||
|---|---|---|---|
| Documentation index + reading order. |
|
Docs
Reading order (new contributor):
README.md(repo root): run locally.docs/quickstart.md: end-to-end: search → install → publish → sync.docs/architecture.md: how the pieces fit (TanStack Start + Convex + CLI).docs/skill-format.md: what a “skill” is on disk + on the registry.docs/cli.md: CLI reference (flags, config, lockfiles, sync rules).docs/http-api.md: HTTP endpoints used by the CLI + public API.docs/auth.md: GitHub OAuth + API tokens + CLI loopback login.docs/deploy.md: Convex + Vercel deployment + rewrites.docs/troubleshooting.md: common failure modes.
Feature/ops docs (already present):
docs/spec.md: product + implementation spec (data model + flows).docs/security.md: moderation, reporting, bans, upload gating.docs/telemetry.md: whatclawhub syncreports; opt-out.docs/webhook.md: Discord webhook events/payload.docs/diffing.md: version-to-version diff UI spec.docs/manual-testing.md: CLI smoke scripts.
Docs tooling:
docs/mintlify.md: publish these docs with Mintlify.