mirror of https://github.com/openclaw/clawhub.git synced 2026-08-14 00:47:57 +00:00

Files

T

Patrick Erichsen fdb4d312f4 docs: restore OpenClaw-hosted ClawHub docs (#2631 )

* Revert "fix: serve docs subdomain root (#2630)"

This reverts commit 9ef33726b8.

* Revert "feat: move docs to canonical subdomain"

This reverts commit 6afb91b772.

* Revert "docs: serve ClawHub docs with shared OpenClaw renderer (#2609)"

This reverts commit 71156751ff.

* 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

2026-06-14 16:05:34 -07:00

1.1 KiB

Raw Permalink Blame History

summary, read_when

summary

read_when

Mintlify setup notes for publishing docs/.

Setting up docs site

Mintlify

Goal: publish docs/ as a browsable docs site (nice UX for OSS users).

This repo does not include Mintlify config yet (mint.json missing).

Minimal setup

Install Mintlify CLI (per Mintlify docs).
Add a mint.json at repo root that points to docs/ pages.

Example (starter):

{
  "name": "ClawHub",
  "logo": "public/logo.svg",
  "navigation": [
    { "group": "Start", "pages": ["docs/README", "docs/quickstart"] },
    { "group": "Concepts", "pages": ["docs/architecture", "docs/skill-format", "docs/telemetry"] },
    { "group": "Reference", "pages": ["docs/cli", "docs/http-api", "docs/auth", "docs/deploy"] }
  ]
}

Notes:

Mintlify usually wants page paths without extension; keep files as .md.
If you prefer Mintlify conventions, rename to .mdx later (optional).

Recommended “docs UX” additions

Add an “Overview” page (use docs/README.md).
Keep “Quickstart” copy/paste friendly.
Provide CLI + HTTP API reference pages (done here).
Add a Troubleshooting page for common setup failures.

1.1 KiB Raw Permalink Blame History

Mintlify

Minimal setup

Recommended “docs UX” additions

1.1 KiB

Raw Permalink Blame History