Note

    README

    Canonical documentation map for the project

    Document Metadata

    • title: Documentation Index
    • description: Canonical documentation map for the project
    • status: stable
    • lastUpdated: "2026-03-09 14:52 ET (America/New_York)"
    • owner: Documentation

    Documentation Index Welcome to the project documentation hub. This index keeps the knowledge base predictable and easy to navigate.

    Documentation Index

    Welcome to the project documentation hub. This index keeps the knowledge base predictable and easy to navigate.

    Governance

    • AGENTS.md — AI/automation guardrails
    • CLAUDE.md — Claude Code project instructions aligned with repository policy
    • .claude/settings.json — Claude Code permission guardrails for this repository
    • ROADMAP.md — priorities and milestones
    • CHANGELOG.md — notable changes

    Projects (Planning & Tracking)

    • docs/projects/active/ — in progress
    • docs/projects/completed/ — delivered
    • docs/projects/backlog/ — queued
    • docs/projects/stale/ — paused or deprecated

    See docs/projects/README.md for rules and numbering. Project template: docs/projects/NNNN_project_template.md.

    Product & Feature Guides

    • docs/features/
    • docs/getting-started/
    • docs/merchant/ (merchant-facing help docs)

    Engineering Guides

    • docs/development/ (flat layout; no nested folders)
    • docs/development/checkpoint-workflow.md (timestamped checkpoint standard)
    • docs/internal/ (operator and implementation guides)

    Database

    • docs/database/

    Historical

    • docs/historical/

    Docs Site

    • Local dev: npm --prefix docs-site run dev
    • Build: npm --prefix docs-site run build
    • Cloudflare Pages: Root Directory repo root, Build command npm --prefix docs-site run build, Build output directory docs/.vitepress/dist
    • Auto deploy: .github/workflows/deploy-docs.yml deploys to Cloudflare Pages on pushes to main when files under docs/merchant/** change.

    Provenance