Reading order & code map
Purpose
Section titled “Purpose”Give a concrete sequence for reading docs and opening the same files in the repo so mental model and filesystem stay aligned.
Week 1 — orientation
Section titled “Week 1 — orientation”| Step | Doc page | Open in repo (from leekimerp/) |
|---|---|---|
| 1 | Reference vs implementation | — |
| 2 | Platform primer | hooks.py (skim app_name, installed apps) |
| 3 | System overview, Request flow | hooks.py, api/ |
| 4 | Module catalog, Lee Kim Alliance ERP | modules.txt, lee_kim_alliance_erp/ |
| 5 | Application lifecycle | lee_kim_alliance_erp/doctype/application/ |
| 6 | DocType reference | **/doctype/*/*.json |
Week 2 — integrations & extension points
Section titled “Week 2 — integrations & extension points”| Step | Doc page | Open in repo |
|---|---|---|
| 1 | Xero | api/xero.py |
| 2 | Stripe | api/stripe.py, api/stripe_webhook.py |
| 3 | Payroll | scripts/salary_slip.py, hook_methods.py |
| 4 | API inventory | api/*.py (cross-check) |
| 5 | Doc events, Schedulers | hooks.py |
| 6 | Architecture decisions, Environment matrix | site_config.json patterns (names only in docs) |
| 7 | Operational runbook | Supervisor / bench procedures for your host |
“Vertical slice” — one feature end to end
Section titled ““Vertical slice” — one feature end to end”Pick Billing → email → Application or Payroll Entry → Salary Slip:
- Read the Tutorial scenario page for that slice (Billing → Xero, Payroll).
- In DocType reference, open Billing / Application / Salary Slip (standard) as needed.
- Use grep from repo root:
rg 'function_name' leekimerpfor the symbol you saw in the doc.
Code map quick reference
Section titled “Code map quick reference”Week 3 — documentation hygiene (recommended)
Section titled “Week 3 — documentation hygiene (recommended)”| Step | Action |
|---|---|
| 1 | Skim Documentation inventory — identify thin pages you own. |
| 2 | Read Domain documentation strategy — agree how to extend DocType narratives. |
| 3 | Walk Handover completion checklist with your lead. |