Documentation Overview

This folder complements the main repository README with deeper dives into the UI, backend services, and testing strategy. Use the quick links below to jump to the topic you need:

  • frontend.md: Web UI architecture, key components, and validation behaviour.
  • backend.md: FastAPI endpoints, synthesis service plumbing, and metadata flow.
  • testing.md: Pytest organisation, Playwright end-to-end checks, and recommended quick commands.
  • deployment.md: Docker, Cloud Run, and Vercel deployment tips plus required environment variables.
  • privacy.md: High-level guidance on epsilon/delta, rho-CDP, and how each synthesiser consumes the budget.
  • media/: Sequence diagrams and flow charts used by the README.
  • sample_output/: Example synthetic CSV and evaluation metrics to preview the final artefacts.

Want to add more detail? Create a new Markdown file under docs/ and cross-link it here and in the main README.