README.md

Graft Documentation Portal

This repository contains a community documentation portal for Graft — the open-source context layer for AI coding agents.

The site is built with Astro Starlight and structured using the Diataxis framework, organizing content into Tutorials, How-To Guides, Reference, and Explanation.

🚀 Quick Start

Ensure you have Node.js installed, then run:

# Install dependencies
npm install

# Start the local development server
npm run dev

The site will be available at http://localhost:4321.

📁 Repository Structure

All documentation content lives in src/content/docs/. The structure follows Diataxis:

src/content/docs/
├── index.mdx                       # Landing page
├── tutorials/                      # Learning-oriented: step-by-step guides
│   ├── getting-started.mdx
│   └── your-first-graph.mdx
├── how-to/                         # Task-oriented: solving specific problems
│   ├── integrate-claude-code.mdx
│   ├── set-up-mcp-server.mdx
│   └── ...
├── reference/                      # Information-oriented: technical descriptions
│   ├── cli.mdx
│   ├── graph-structure.mdx
│   └── ...
└── explanation/                    # Understanding-oriented: concepts and background
    ├── why-graft-exists.mdx
    ├── how-the-graph-works.mdx
    └── ...

🛠️ Development & Testing

This project uses Vitest to ensure the documentation structure remains intact.

# Run the test suite
npm run test:run

# Build the site for production
npm run build

# Preview the production build locally
npm run preview

🌐 Deployment

This site is configured for static deployment on Vercel via the @astrojs/vercel adapter.

Any pushes to the main branch will automatically build and deploy using the npm run build command. The Vercel configuration is defined in vercel.json and astro.config.mjs.