1.2 KiB
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
- Newcomer / product → product.md
- Architecture → architecture.md
- Local development → development.md
- Deployment → deployment.md (plus the ops shortcut in
deploy/README.md) - Security & launch → security.md
- Day-to-day ops → operations.md
- API contract → api.md
- 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.
Related files outside docs/
| File | Role |
|---|---|
CONTEXT.md |
Short domain summary for agents / fast onboarding |
deploy/README.md |
Deploy command shortcut |
.env.example / .env.prod.example |
Secret templates |