Openclaw-go docs-site
Build, preview, and update the VitePress documentation site in docs-site/
install
source · Clone the upstream repo
git clone https://github.com/a3tai/openclaw-go
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/a3tai/openclaw-go "$T" && mkdir -p ~/.claude/skills && cp -r "$T/.opencode/skills/docs-site" ~/.claude/skills/a3tai-openclaw-go-docs-site && rm -rf "$T"
OpenClaw · Install into ~/.openclaw/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/a3tai/openclaw-go "$T" && mkdir -p ~/.openclaw/skills && cp -r "$T/.opencode/skills/docs-site" ~/.openclaw/skills/a3tai-openclaw-go-docs-site && rm -rf "$T"
manifest:
.opencode/skills/docs-site/SKILL.mdsource content
What I do
Manage the openclaw-go VitePress documentation site — build it, preview it, add or update pages, and fix issues.
When to use me
Use this skill when working on the docs site, adding new package documentation, updating guides, or debugging build/deploy issues.
Site structure
docs-site/ .vitepress/ config.mts — VitePress configuration (nav, sidebar, theme) theme/ index.ts — custom theme extending DefaultTheme custom.css — amber brand colors, dark mode, component styles public/ mascot-gpt.png — site logo and favicon index.md — home page (hero + feature cards) changelog.md — includes ../CHANGELOG.md via @include directive guide/ getting-started.md authentication.md streaming.md packages/ gateway.md protocol.md chatcompletions.md openresponses.md toolsinvoke.md discovery.md acp.md
Commands
All commands run from
docs-site/:
| Command | Purpose |
|---|---|
| Install dependencies (clean) |
| Dev server with hot reload |
| Build static site to |
| Serve built site locally at |
Key configuration
- Base path:
(GitHub Pages project site)/openclaw-go/ - Clean URLs: enabled (no
extensions).html - Search: local provider
- Logo/favicon:
/mascot-gpt.png - Edit links: point to
https://github.com/a3tai/openclaw-go/edit/main/docs-site/:path
Adding a new package page
- Create
docs-site/packages/<name>.md - Add to sidebar in
under.vitepress/config.mts
items/packages/ - Add a feature card to
if appropriateindex.md - Build and preview to verify
Adding a new guide page
- Create
docs-site/guide/<name>.md - Add to sidebar in
under.vitepress/config.mts
items/guide/ - Add "Next Steps" links from related pages
- Build and preview to verify
Deployment
The site deploys to GitHub Pages via
.github/workflows/docs-deploy.yml:
- Triggered on version tags (
) or manualv*workflow_dispatch - Uses Node 22,
,npm cinpm run build - Deploys
as a Pages artifact.vitepress/dist/
Rules
- Always build and preview before committing docs changes
- The changelog page auto-includes
— do not duplicate content../CHANGELOG.md - Use the amber brand color
for any new styled elements#f5a623 - Keep code examples consistent with actual library API