TrueCalc Docs

Documentation site for TrueCalc — built with Fumadocs (Next.js, static export), deployed to GitHub Pages.

Layout

The docs UI is served at the app root, so on GitHub Pages (base path /docs) the final URLs are:

• content/docs/learn/ — the Learn tab (https://truecalc.github.io/docs/learn): beginner→advanced guide, written phase-by-phase alongside the code. Marked code examples are executed in CI.
• content/docs/reference/ — the Reference tab (https://truecalc.github.io/docs/reference): function pages (generated from functions.json in truecalc/core), error codes, dialects, workbook schema.
• content/docs/api/ — the API tab (https://truecalc.github.io/docs/api): MCP tools and the hosted REST API.
• content/docs/index.mdx — the site homepage (https://truecalc.github.io/docs/).

Commands

npm ci             # install (pins @truecalc/core exactly)
npm run dev        # local dev server
npm run build      # static export to out/
npm run test-docs  # execute marked Learn examples against @truecalc/core
npm run gen-docs   # regenerate content/docs/reference/functions/

CI (.github/workflows/ci.yml) runs gen-docs drift check, test-docs, and the build on every PR. Deploys to GitHub Pages happen from main (.github/workflows/deploy.yml).

See CLAUDE.md for contribution rules (PR-only, fixture-citation rule, version pinning).