This directory contains the primary documentation for the repository.
- Architecture Overview — high-level design and layering
- Getting Started — build, test, and run the demo
- Testing Guide — testing philosophy and commands
- Serverless Deployment Guide — deploying to per-request runtimes (Cloudflare Workers + Hyperdrive worked example, with pointers for AWS Lambda, Vercel, Deno, Bun)
- ADRs — decisions (append-only)
- Subsystems — deeper technical guides by subsystem
- Package Layering — package boundaries and import constraints
- Glossary — user-facing terminology (source of truth for naming)
- Commands — command docs and entry points
- Reference docs — conventions and patterns used across the codebase
- Codec authoring guide — class-based codecs (
CodecImpl,CodecDescriptorImpl) and column helpers - Mongo Pipeline Builder — typed builder for MongoDB aggregation pipelines, reads, writes, and find-and-modify
migration graph --treerendering — condensed annotated-tree rendering for offline migration topology- Why Prisma Next only supports externally-managed native Postgres enums — the rewrite/atomicity costs behind managed native enums being create/add-value-only
- CLI Style Guide — CLI UX conventions
- Cursor Cloud Agents — how cloud agents run against this repo, where config lives, how to change it, how to debug a failed run
- OSS posture overview — index of governance, supply-chain, and contribution policies
- Governance — maintainer team, decision-making, DCO basis
- Supply chain — license validation, NOTICE audit, npm provenance, Dependabot cooldown
- Versioning — source of truth, lockstep, dist-tag convention, release procedure
- Supported Versions — minimum Node, TypeScript, PostgreSQL, MongoDB, Bun, Deno versions
- Telemetry — what the CLI collects, the user-level config file, env-var opt-outs, the
initconsent prompt, agent detection