Feature inventory by sidebar category
Purpose
Section titled “Purpose”Single feature list aligned with the current Starlight sidebar (astro.config.mjs). Use it for onboarding and scope discussions.
| Category | What it covers | Key pages | Code / generated |
|---|---|---|---|
| Start | First-day orientation, scope, glossary, deliverables | Start guide, Overview, How to read, Glossary, Reference vs implementation, Deliverables | Repo root README, leekimerp/ |
| Tutorial | Reading order and vertical-slice scenarios | Reading order, Billing → Xero, Payroll | tasks.py, api/xero.py, scripts/salary_slip.py |
| Platform & architecture | Stack, request path, naming rules, ADR, env matrix | Platform primer, Documentation conventions, System context, System overview, Request flow, Technology stack, Architecture decisions, Environment matrix, Handover completion checklist, Test evidence, Documentation inventory, Documentation upgrade roadmap | hooks.py, api/, architecture docs |
| Modules & domains | Frappe modules and Lee Kim deep dives | Module catalog, MOD mapping, Lee Kim subtree, Payroll, Time tracking, Socket.io | lee_kim_alliance_erp/, time_tracking_module/, modules.txt |
| Data & features | Schema, generated DocType refs, feature/report catalogs, domain doc strategy | Custom DocTypes, ER diagrams by domain, Domain documentation strategy, Domain — Finance & AR, Domain — Incorporation & application, DocType reference (generated), Feature catalog, Reports catalog | **/doctype/*/*.json, generate-doctype-reference.mjs, doctype-overlays/, report/ |
| Integrations | Third-party systems | Xero, Stripe, DocuSign, Singpass | api/xero.py, api/stripe*.py, api/docusign.py, Singpass package |
| APIs & code hooks | Extension points | API inventory, Doc events, Schedulers, Server scripts, Overrides, Flows | hooks.py, override/, scheduler_events/ |
| Operations | Deploy, security, roadmap, runbook | Deployment, Operational runbook, Cloudflare Pages, Security, Known issues | CI, deploy-docs.yml, Bench ops |
When you change the sidebar (astro.config.mjs)
Section titled “When you change the sidebar (astro.config.mjs)”This table is manually aligned with Starlight sidebar entries. After adding, renaming, or removing a page:
- Update this table so category ↔ page links stay accurate.
- If you added a top-level section, add a row above (do not leave orphan pages only in autogenerated groups without a mention).
- Consider a small script later: parse
astro.config.mjsand diff against slugs (design-only — see Documentation upgrade roadmap).
Related
Section titled “Related”- Documentation upgrade roadmap
- Diagram roadmap — which diagram types fit which pages.
- Start guide — suggested reading order.