nixcafe-docs

Documentation monorepo for nixcafe.org — built with Vocs, powered by Bun.

---

Sites

Site	URL	Source	Coverage
landing	nixcafe.org	apps/landing/	Project hub & landing page
purr	purr.nixcafe.org	apps/purr-docs/	9 pages — quick start, flake-parts, mkFlake, modules, directory structure, systems/homes, host meta, hydraJobs, 40-function API reference
develop-templates	templates.nixcafe.org	apps/develop-templates/	4 pages — quick start, 13 templates catalog, architecture, contributing
cattery	cattery.nixcafe.org	apps/cattery-modules/	6 pages — quick start, room hierarchy, 244+ module catalog, agenix secrets, contributing

Structure

apps/
├── landing/                  # nixcafe.org
├── purr-docs/                # purr.nixcafe.org
├── develop-templates/        # templates.nixcafe.org
└── cattery-modules/          # cattery.nixcafe.org

packages/
└── shared-theme/             # shared Vocs theme (defineNixcafeTheme)

develop/
├── shells/default/           # Nix dev shell (bun, biome, git-hooks)
└── checks/git-hooks/         # pre-commit (biome, typecheck, test)

flake.nix                     # Nix flake using purr/mkFlake
package.json                  # Bun workspace root

Development

nix develop                    # enter dev shell (or direnv allow)

bun install                    # install deps
bun dev                        # start all doc sites
bun run --filter <name> dev   # start a specific site
bun --filter '*' build         # build all sites

Commands

bun fmt          # format all files (biome)
bun lint         # lint all files (biome)
bun check        # format + lint (read-only)
bun typecheck    # TypeScript type checking
bun test         # run tests
bun ci:check     # full PR pipeline (biome ci + typecheck + test)

Tech Stack

Tool	Purpose
Vocs	Static documentation (React + MDX)
Bun	Package manager & workspace orchestration
Biome	Formatter & linter
TypeScript	Type checking
purr	Nix flake auto-discovery
git-hooks.nix	pre-commit hooks

License

CC0 1.0 Universal