Documentation Templates¶
Reusable Markdown starting points. Copy, don't link, and fill with real content when you add something new.
Code/feature templates¶
| Template | Use when |
|---|---|
| feature.md | Adding a new feature |
| rest-api.md | Adding/changing a REST endpoint |
| websocket-event.md | Adding/changing a WebSocket event |
| service.md | Adding an application service / use case |
| module.md | Adding a new module / feature area |
| runbook.md | Adding an operations runbook |
| ADR template | Recording an architectural decision |
Business agreement templates¶
Legal/business agreement skeletons live in agreements/:
| File | Document |
|---|---|
| agreements/CHIT.md | Chit agreement |
| agreements/KSFE_CHITTY.md | KSFE chitty agreement |
| agreements/KSFE_CHITTY_EN.md | KSFE chitty (EN) |
| agreements/MAZHUPPEL_CHITTY_MONTHLY.md | Mazhuppel monthly |
| agreements/MAZHUPPEL_CHITTY_MONTHLY_EN.md | Mazhuppel monthly (EN) |
| agreements/MONTHLY_CHITTY_EN.md | Monthly chitty (EN) |
Rules¶
- Copy the relevant template; keep the section order and Markdown-level structure so the docs stay consistent (see ../contributing.md).
- Fill every applicable section with real content — no lorem ipsum.
- Update the PR checklist at the bottom of each template as part of the review.