Developer and admin documentation for Barazo, hosted at docs.barazo.forum. Built with Fumadocs (Next.js). API reference is auto-generated from the OpenAPI spec; TypeScript type docs are auto-generated from lexicon source files.
| Component | Technology |
|---|---|
| Framework | Fumadocs (Next.js 16 / React 19 / TypeScript strict) |
| Styling | TailwindCSS |
| API docs | fumadocs-openapi (auto-generated from OpenAPI spec) |
| Type docs | fumadocs-typescript (auto-generated from source) |
| Search | Orama (self-hosted, audience-scoped) |
| Icons | Phosphor Icons |
| Typography | Source Sans 3 / Source Code Pro (self-hosted) |
| Output | Static export (zero server runtime) |
| Section | Audience | Description |
|---|---|---|
| Getting Started | Both | Quickstart overview |
| Self-Hosting | Admin | Requirements, installation, configuration, upgrading |
| Admin Guide | Admin | Moderation, categories, customization, plugins |
| API Reference | Developer | Auto-generated from OpenAPI spec (interactive playground) |
| Lexicon Reference | Developer | Auto-generated TypeScript type documentation |
| AT Protocol | Developer | AT Protocol concepts for Barazo |
| Plugin Development | Developer | Building and publishing plugins |
| Contributing | Developer | Contributing to Barazo |
| Migration | Admin | Migrating from other forum platforms |
| FAQ | Both | Frequently asked questions |
Audience-scoped sidebar tabs (Developer / Admin) provide separate navigation trees with scoped search.
Prerequisites: Node.js 24 LTS, pnpm.
git clone https://github.com/singi-labs/barazo-docs.git
cd barazo-docs
pnpm install
pnpm devpnpm dev # Start dev server
pnpm build # Static export
pnpm lint # ESLint
pnpm typecheck # TypeScript strict modeSee CONTRIBUTING.md for contribution guidelines.
Key standards:
- Strict TypeScript --
strict: true, noany, no@ts-ignore - WCAG 2.2 AA accessibility from first commit
- Static export -- all pages pre-rendered at build time
- Auto-generated docs rebuild when barazo-api or barazo-lexicons update
Two categories of documentation are generated at build time rather than written by hand:
API Reference -- The Barazo API (barazo-api) generates an OpenAPI spec from its Zod validation schemas via @fastify/swagger. The fumadocs-openapi package converts this spec into interactive documentation pages with parameter tables, request/response schemas, code samples, and a live API playground.
Lexicon Type Docs -- The fumadocs-typescript package reads TypeScript type definitions from barazo-lexicons and generates type documentation tables. Changes to lexicon schemas automatically update the docs on the next build.
| Repository | Description | License |
|---|---|---|
| barazo-api | AppView backend (Fastify, PostgreSQL, AT Protocol) | AGPL-3.0 |
| barazo-web | Forum frontend (Next.js, TailwindCSS) | MIT |
| barazo-lexicons | AT Protocol schemas for forum data | MIT |
| barazo-deploy | Docker Compose templates for self-hosting | MIT |
| barazo-website | Marketing site | Proprietary |
| barazo-workspace | Project coordination and shared tooling | MIT |
- Website: barazo.forum
- Discussions: GitHub Discussions
- Issues: Report bugs
This repository uses a dual license:
Content (MDX documentation files in content/): CC BY-SA 4.0
Code (Fumadocs configuration, components, layouts, build scripts): MIT
See LICENSE for the content license and LICENSE-CODE for the code license.
Made with ♥ in 🇪🇺 by Singi Labs