Brainstorm — docs

The documentation for Brainstorm, a desktop OS for you and your AI — live at docs.getbrainstorm.online.

Built with Astro + Starlight, themed to match getbrainstorm.online. The docs cover both sides of the product: using Brainstorm (vaults, apps, objects, sync, the permission model) and building on it (the app model, manifest, capabilities, SDK, data layer).

Readable by agents, by design

Brainstorm is a product about giving AI governed access to your knowledge, so its docs are natively readable by agents — every page ships a plain-Markdown twin via starlight-llms-txt:

• /llms.txt — an index of the docs for agents
• /llms-full.txt — the entire documentation as one Markdown file
• append .md to any page URL for that page alone

Structure

src/content/docs/
  index.mdx            # splash landing
  start-here/          # what is brainstorm, install, quickstart
  concepts/            # vaults, apps & permissions, objects, sync, security
  apps/                # per-app pages (autogenerated sidebar)
  build/               # developer hub: app model, manifest, capabilities, SDK, data

• Sidebar and site config: astro.config.mjs
• Brand theme, matching the marketing site: src/styles/brand.css

The build/ section is the hand-written developer hub for app builders. The auto-generated reference (SDK API, capability catalogue, IPC/wire format) lands alongside the app-publishing pipeline.

Develop

bun install
bun run dev          # starlight dev server (port 4321)
bun run build        # static build to dist/
bun run preview      # serve the production build locally

Deploy

Static build deployed on Vercel to docs.getbrainstorm.online. Config in vercel.json.

License

Documentation content is licensed under CC BY 4.0 — share and adapt with attribution to Brainstorm. Code samples in the docs are free to use without restriction.