Shipflash logoDocs

Documentation

Docs should explain setup, module ownership, operations, and removal paths without hiding important code boundaries.

On this page

Docs files

FileUse
docs/launch.mdProduction launch checklist.
docs/deployment.mdHost-agnostic deployment guide (Vercel, Netlify, Railway).
docs/customization.mdBranding, UI, and copy customization guide.
docs/development.mdFeature development workflow rules.
docs/architecture.mdPlatform architecture boundary guidelines.
docs/module-removal.mdSafe module removal checklist.
docs/testing.mdTesting guidelines and layers.
docs/operations.mdProduction operations, data retention, and scheduled jobs.
docs/billing/setup.mdStripe and Lemon Squeezy integration guides.
docs/email/setup.mdSupabase Auth and Resend transactional email configurations.

When to update docs

  • Add new env vars.
  • Add or change a provider setup step.
  • Add a cron job or webhook.
  • Change a module boundary or route map.
  • Add a migration or data repair step that operators need to know.