AgenticGoKit Documentation

This directory contains the VitePress-powered documentation website for AgenticGoKit.

Development

Prerequisites

• Node.js 18+
• npm or yarn

Setup

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Project Structure

docs/
├── .vitepress/
│   ├── config.ts          # VitePress configuration
│   ├── theme/             # Custom theme (to be added)
│   └── public/            # Static assets served at site root (e.g., /logo.svg)
├── getting-started/       # Getting started guides
├── tutorials/             # Step-by-step tutorials
├── guides/                # Comprehensive guides
├── reference/             # API reference
├── contributors/          # Contributor documentation
└── index.md              # Homepage

Content Guidelines

Markdown Files

• Use frontmatter for page metadata
• Follow consistent heading hierarchy
• Include code examples with proper syntax highlighting

Dev vs Build (GitHub Pages)

• Dev base: / → reference assets as /logo.svg.
• Build base: /agenticgokit/ (auto-set). Do not hard-code /agenticgokit in Markdown.
• To preview production base locally:

# PowerShell
$env:DOCS_BASE="/agenticgokit/"; npm run preview
- Add cross-references between related pages

### What to publish to GitHub Pages

Upload only the contents of `.vitepress/dist` to your Pages branch (e.g., `gh-pages`).

### Code Examples

- Use appropriate language tags for syntax highlighting
- Include complete, runnable examples
- Test all code examples before publishing
- Provide context and explanations

### Navigation

- Update `.vitepress/config.ts` when adding new sections
- Maintain logical hierarchy in sidebar navigation
- Use descriptive link text and page titles

## Deployment

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.

### Manual Deployment

```bash
# Build the site
npm run build

# The built files will be in .vitepress/dist/

Contributing

1. Make changes to markdown files
2. Test locally with npm run dev
3. Submit pull request with clear description
4. Ensure all links work and content renders correctly

For more information, see the Contributor Guide.