Skip to content

Reading order & code map

Give a concrete sequence for reading docs and opening the same files in the repo so mental model and filesystem stay aligned.

StepDoc pageOpen in repo (from leekimerp/)
1Reference vs implementation
2Platform primerhooks.py (skim app_name, installed apps)
3System overview, Request flowhooks.py, api/
4Module catalog, Lee Kim Alliance ERPmodules.txt, lee_kim_alliance_erp/
5Application lifecyclelee_kim_alliance_erp/doctype/application/
6DocType reference**/doctype/*/*.json

Week 2 — integrations & extension points

Section titled “Week 2 — integrations & extension points”
StepDoc pageOpen in repo
1Xeroapi/xero.py
2Stripeapi/stripe.py, api/stripe_webhook.py
3Payrollscripts/salary_slip.py, hook_methods.py
4API inventoryapi/*.py (cross-check)
5Doc events, Schedulershooks.py
6Architecture decisions, Environment matrixsite_config.json patterns (names only in docs)
7Operational runbookSupervisor / 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:

  1. Read the Tutorial scenario page for that slice (Billing → Xero, Payroll).
  2. In DocType reference, open Billing / Application / Salary Slip (standard) as needed.
  3. Use grep from repo root: rg 'function_name' leekimerp for the symbol you saw in the doc.

Async / cron

Core app

Entry

hooks.py

api/

lee_kim_alliance_erp/doctype/

scripts/

override/

tasks.py

scheduler_events/

Section titled “Week 3 — documentation hygiene (recommended)”
StepAction
1Skim Documentation inventory — identify thin pages you own.
2Read Domain documentation strategy — agree how to extend DocType narratives.
3Walk Handover completion checklist with your lead.