Contributing

Edit content

1. Add or edit MDX under content/docs/
2. Update the nearest meta.json (and root meta.json for new top-level sections)
3. Run checks locally

Every page needs frontmatter:

---
title: Page Title
description: "One line for humans"
llmDescription: "Dense paragraph for LLM index — mechanisms, invariants, key names."
---

Wrap values in quotes if they contain colons.

Commands

pnpm install
pnpm check:frontmatter
pnpm build
pnpm dev

LLM-first conventions

Pages are primary LLM feedstock:

• High technical depth, precise contract/API names
• Self-contained sections (minimal "as above" without context)
• Mermaid for flows, tables for constants
• llmDescription must differ from description — denser, for /llms.txt

Sync with app repo

When changing pumperp backend behavior, update the matching docs page in the same PR cycle (or immediately after merge to pumperp/main).

Canonical product briefing for agents lives in pumperp/AGENTS.md — keep docs aligned when fee model or workers change.

Pull requests

Open PRs against pumperp-docs. CI should run pnpm check:frontmatter && pnpm build.