Barq Docs

Astro Starlight documentation for Barq.

This README is for docs maintainers. Readers of the Barq docs do not need to know or run these commands.

Project Structure

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   └── docs/
│   └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Commands

All commands are run from the root of the project, from a terminal:

Command	Action
bun install	Installs dependencies
bun run dev	Starts local docs at localhost:4321
bun run check	Checks Astro and TypeScript
bun run build	Builds the MCP index and docs
bun run preview	Previews the built docs
bun run mcp:index	Builds .barq-mcp/index.json
bun run mcp:http	Starts the MCP server at 127.0.0.1:7331/mcp

MCP

The MCP server is read-only. Build the index before starting it:

bun run mcp:index
bun run mcp:http