Documentation Coverage & Registries
Updated 2026-09-06. This is the control sheet: what's documented, the ID schemes, and what's next. Update it whenever you add a page.
Coverage
| Section | Deliverable | Status |
|---|---|---|
| Framework | README, METHODOLOGY, templates, _tools/ (DB inspector + dictionary generator, tested) | ✅ done |
| Viewer | developer/index.php (dynamic) + developer/export_static.php (static HTML) + md_render.php | ✅ done (live) |
| 00-architecture | overview, bootstrap-and-config, module-registry, database conventions | ✅ done (validated) |
| 40-financial | central order-finance ledger, wallet, commission/settlement | ✅ done (validated) |
| 30-core | auth, membership, KYC/trust, notifications, cron/background, search-location-radar, platform-engines | ✅ done (validated) |
| 10-actors | identity model + permissions matrix | ✅ (gates validated; CRUD matrix needs authz-code pass) |
| 20-modules | 15 modules: CommerceX (exemplar), Food, Hotels, RideMate, RealEstate, Jobs, Services, Freelancer, Classifieds, Events, Dating, Social, Hyperlocal, Courier, Packers, Business Directory | ✅ done (validated) |
| 25-merchant-suite | CRM/POS/Website Builder/Marketing/Developer/Prism/Billing overview | ✅ done (overview; per-tool pages pending) |
| 26-admin | padmin back-office overview | ✅ done (overview; per-workflow pages pending) |
| 90-database | data dictionary — all 1,797 tables generated + index | ✅ done (regenerate on schema change) |
| 50-errors | Error Center + symptom-first troubleshooting | ✅ seeded (grows per module) |
| 60-registry | consolidated feature registry | ✅ seeded |
| Modules — remaining | Trip Planner, Business Profiles, Investor/VC, Startup Passport, Campus, CareerLab/YEP, Founders Network | ⬜ |
| Merchant suite — per-tool | full CRM/Website Builder/etc. pages (feature IDs, flows) | ⬜ |
| QA traceability (§29) | feature→test links (to docs/mastertesting.md) | ⬜ |
| Portal build (§31) Phase 2–4 | structured kvdoc_* DB + traceability views | 📋 planned — PORTAL_BUILD_PLAN.md |
Feature ID scheme (§28)
<PREFIX>-NNN. Register every feature here as it is documented; keep IDs stable forever.
| Prefix | Area |
|---|---|
AUTH | authentication & account lifecycle |
IDN | identity / roles / profiles |
MEM | membership |
KYC | KYC / verification / trust |
WAL | wallet |
PAY | payments / gateway |
FIN | order-finance ledger / commission / settlement |
SOC | social / feed |
COM | CommerceX |
FOOD STAY RIDE RLTY JOB FREE SVC CLS EVT DATE PKM CUR HYP TRIP DIR BIZ UE CMP | the respective modules |
NOTF | notifications |
ADM | admin / back-office |
Documented so far: COM-001…010 (see 20-modules/ecommerce/overview.md).
Error ID scheme (§20)
<PREFIX>-E<NNN>. Each error carries: message, technical cause, trigger, impact, detection, resolution, tables, logs, severity, status, related. Seeded: COM-E001/E002/E003 (see the CommerceX wallet-checkout flow). A consolidated 50-errors/ Error Center is a later deliverable; until then, errors live in each module's section L and are indexed here.
Business rule ID scheme (§ template I)
BR-<MODULE>-NNN. E.g. BR-COM-001: checkout must resolve price server-side, never from client (CommerceOrdersModule.php:692-748).
Immediate next actions
- Run the full data dictionary once and commit the module-relevant
tables/*.md. - Auth & identity pass (signup/login/OTP) → unblocks the permissions matrix.
- FoodVerse module (second exemplar; confirms the template generalizes to another money flow).
- Wallet + commission + settlement detail pages under
40-financial/.