Skip to content

DocuShark Docs (VitePress)

Source for docs.docushark.app, built with VitePress.

Commands

Run from docs-site/:

CommandAction
bun installInstall dependencies
bun run devStart the local dev server
bun run buildProduction build (online mode — fetches live data where applicable)
bun run build:offlineProduction build without network calls — use this to verify changes locally
bun run previewPreview a built site locally

Structure

  • getting-started/ + guide/ — the user-facing guides, sharing one sidebar (guidesSidebar in .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 in developer/architecture.md.
  • .vitepress/config.mts — sidebar/nav structure, breadcrumb JSON-LD, and llms.txt/llms-full.txt generation. Any new top-level nav section needs a matching sidebar array, a resolveBreadcrumb branch, and a buildEnd section here.
  • .vitepress/plugins/llms.ts — generates /llms.txt + /llms-full.txt from 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), so shape-libraries.md never drifts from what's actually in the app.

See the repo root AGENTS.md (one directory up) for the DocuShark codebase's broader conventions.

Released under the AGPL-3.0 License.