# Voltage

> Auto-documentation platform that generates living docs directly from code — and flags what's changing before it ships.

## What Voltage does

Voltage is a GitHub-connected SaaS platform for non-technical stakeholders (product managers, data analysts, designers, legal, finance) who need to understand and shape what engineering teams are building — without reading code.

Users configure **Pages** that watch specific files in a GitHub repository. When code is pushed to the main branch, Voltage generates or regenerates a human-readable documentation page using Claude AI (Anthropic), with every claim cited back to the source file it came from.

Voltage also integrates into PR workflows: when a pull request touches files that a Page is watching, Voltage generates a preview of the documentation change and opens a review workflow. Non-engineers can read the proposed change, comment on what's wrong, approve when it's right, and have their feedback synced back to the GitHub PR as comments.

## Core concepts

- **Page** — A documentation unit that watches one or more source files and holds a prompt describing what to document. Pages regenerate automatically on every push to main.
- **Group** — A named collection of Pages inside a Workspace.
- **Workspace** — A scoped space within an account. Can be public (anyone with the link) or private (members only).
- **PageVersion** — A snapshot of a Page's generated content at a point in time (PUBLISHED or PREVIEW/DRAFT).
- **Review** — A PR-triggered workflow where non-engineers can read and comment on documentation changes before code merges.
- **Integration** — A GitHub App installation scoped to an organization. One integration covers all repositories from that org.
- **Source file roles** — Each watched file has a role: `source` (included verbatim), `crawl_entry` (BFS import traversal up to N levels), or `reverse_ref` (finds all files that import this one).

## User roles

- **VIEWER** — Read published docs, subscribe to pages, comment on docs.
- **BUILDER** — VIEWER + create/edit Pages, trigger generation.
- **ADMIN** — BUILDER + manage users, workspace settings, integrations.
- **OWNER** — ADMIN + billing. One per account.

## Plans

- **Free** — 1 repository, 1 page, 2 regenerations/month, 1 seat.
- **Pro** — 5 repositories, 20 pages, 200 regenerations/month, up to 250 seats.
- **Enterprise** — 25 repositories, 100 pages, 1,000 regenerations/month, up to 1,000 seats.
- BYOK (bring your own Anthropic API key) unlocks unlimited regenerations on Pro and Enterprise.

## Integrations

- **GitHub** — Source of truth for all documentation. GitHub App installation; supports push events and pull request events.
- **Slack** — Per-user notification delivery via OAuth.
- **Microsoft Teams** — Per-user notification delivery via webhook URL.
- **Email** — Via Postmark.
- **Notion** — Doc sync (in roadmap).

## Technology

- Next.js 15 (App Router) with TypeScript
- GraphQL API (Apollo Server 4 + TypeGraphQL)
- PostgreSQL via Prisma ORM
- Redis + BullMQ for webhook processing
- Claude AI (Anthropic) for documentation generation, temperature 0
- GitHub App for repository access and webhook ingestion

## Contact

- Website: https://voltagedocs.ai
- App: https://app.voltagedocs.ai
- LinkedIn: https://www.linkedin.com/company/voltage-docs/
- Demo: Book at https://voltagedocs.ai (closed beta — invitation required)