Files
ahp 5b9b2a16e6 docs: add product overview and engineering documentation
Document architecture, security, deployment, and development for contributors.
2026-10-07 19:40:26 +03:30

1.2 KiB

Pargar documentation

This folder is the engineering source of truth. README.md is only the entry point; details live here.

Reading map

  1. Newcomer / product → product.md
  2. Architecture → architecture.md
  3. Local development → development.md
  4. Deployment → deployment.md (plus the ops shortcut in deploy/README.md)
  5. Security & launch → security.md
  6. Day-to-day ops → operations.md
  7. API contract → api.md
  8. Env & settings → configuration.md

Writing conventions

  • File paths, env names, shell commands, and route names stay in exact English.
  • Prefer linking over long duplication across files.
  • When behavior changes, update the matching doc in the same PR.
File Role
CONTEXT.md Short domain summary for agents / fast onboarding
deploy/README.md Deploy command shortcut
.env.example / .env.prod.example Secret templates