Connectum Documentation

Minimalist framework for building production-ready gRPC/ConnectRPC microservices on Node.js 22.13+

Modular packages across dependency layers

Documentation Site

This directory contains the VitePress documentation for the Connectum framework.

Development

cd docs
pnpm install
pnpm docs:dev

The documentation site will be available at http://localhost:5173.

Build

pnpm docs:build
pnpm docs:preview

Structure

docs/
├── .vitepress/          # VitePress configuration
│   ├── config.ts        # Main config with i18n
│   └── config/          # Config modules (en, shared)
├── en/                  # English documentation (primary)
│   ├── index.md         # Landing page
│   ├── guide/           # User guide (progressive)
│   │   └── production/  # Production deployment
│   ├── packages/        # Per-package guides
│   ├── api/             # Auto-generated API Reference (TypeDoc)
│   ├── migration/       # Migration & changelog
│   └── contributing/    # Contributing (ADR, architecture)
├── public/              # Static assets (assets/, CNAME, robots.txt)
└── package.json         # VitePress dependency

Links

• Main Repository -- Framework source code
• Examples -- Usage examples