DocuShark Docs (VitePress)
Source for docs.docushark.app, built with VitePress.
Commands
Run from docs-site/:
| Command | Action |
|---|---|
bun install | Install dependencies |
bun run dev | Start the local dev server |
bun run build | Production build (online mode — fetches live data where applicable) |
bun run build:offline | Production build without network calls — use this to verify changes locally |
bun run preview | Preview a built site locally |
Structure
getting-started/+guide/— the user-facing guides, sharing one sidebar (guidesSidebarin.vitepress/config.mts), ordered as a product-flow journey rather than an alphabetical feature list.developer/— the Build section (customer-facing nav label "Build"; routes stay under/developer/). Scoped to two jobs: Extend (shapes, tools, UI features, plugins) and Integrate (REST/MCP consumption, building clients). The engine core + relay CRDT/sync internals are readable AGPL but deliberately not a documented extension surface here — see the "extension surface vs engine core" note indeveloper/architecture.md..vitepress/config.mts— sidebar/nav structure, breadcrumb JSON-LD, andllms.txt/llms-full.txtgeneration. Any new top-level nav section needs a matching sidebar array, aresolveBreadcrumbbranch, and abuildEndsection here..vitepress/plugins/llms.ts— generates/llms.txt+/llms-full.txtfrom the sidebar structures at build time.guide/shape-libraries.data.ts— a VitePress build-time data loader that reads the shape/icon catalog directly from application source (src/shapes/library/,scripts/gen-icon-catalog.ts), soshape-libraries.mdnever drifts from what's actually in the app.
See the repo root AGENTS.md (one directory up) for the DocuShark codebase's broader conventions.
