Files
clawhub/docs
Patrick ErichsenandClaude Opus 4.7 ea0824878d fix(markdown): render raw HTML + GFM in MarkdownPreview, add shiki highlighting
Plugin/soul READMEs that use raw HTML (e.g. centered logos via
<h1 align="center">, <picture>, <br/>) were rendering as escaped
text because @create-markdown/preview escapes all HTML. Swap the
renderer for react-markdown + remark-gfm + rehype-raw +
rehype-sanitize (GitHub's stack), with rehype-shiki-from-highlighter
for fenced code block syntax highlighting.

Sanitize runs before shiki so user HTML is scrubbed, and shiki's
trusted styled output flows through untouched.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 20:33:54 -07:00
..
2026-03-20 10:29:47 -07:00
2026-03-23 19:06:49 -07:00

summary, read_when
summary read_when
Documentation index + reading order.
New contributor onboarding
Looking for the right doc

Docs

Reading order (new contributor):

  1. README.md (repo root): run locally.
  2. docs/quickstart.md: end-to-end: search → install → publish → sync.
  3. docs/architecture.md: how the pieces fit (TanStack Start + Convex + CLI).
  4. docs/skill-format.md: what a “skill” is on disk + on the registry.
  5. docs/cli.md: CLI reference (flags, config, lockfiles, sync rules).
  6. docs/http-api.md: HTTP endpoints used by the CLI + public API.
  7. docs/auth.md: GitHub OAuth + API tokens + CLI loopback login.
  8. docs/deploy.md: Convex + Vercel deployment + rewrites.
  9. 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: what clawhub sync reports; 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.