# Documentation library map (DOS)

**DOS** = Documentation Operating System — the canonical markdown library in this folder.  
**DOC/MACK** = Docs that run inside Master Admin Console (`/admin/master#doc-mack`) with open-external.  
**DOCS/PUBLIC** = Public App Router pages with clean URLs (same pattern as `/policies/terms`) at `/docs/public`.  
**About (product identity)** = `/about` — jurisdiction-aware SaaS positioning (`lib/product-identity.ts`).  
**Play About** = Clicker Settings → About Play (URAPearls) — **not** HUB About.  
**OpenPayGB MoMo phone UI** = flag + dial + E.164 + global networks on `/admin/my-card` (`InternationalMomoPhoneFields`).  
**OpenPayGB merchant tools** = LiveStore · pay-links · bills at `/opgb/*` with tuition **`/admin` hub UI** (`OpgbAdminWorkbench`).  
**Policies** (surfaces refreshed **2 November 2026** for product roots / AssessmentVerse / School Agent; base text `lib/platform-policy-content.ts` · footer via `SITE_LINK_CATALOG`):
- `/policies/terms` — Platform Terms of Service
- `/policies/terms-of-use` — Terms of Use
- `/policies/privacy` — Platform Privacy Policy
- `/policies/disclaimer` — Disclaimer
- `/policies/risk-disclosure` — Risk Disclosure
- `/policies/payment-providers` — Payment Provider Policy

**Interactive hub:** [`index.html`](./index.html) — run `npm run docs:serve` then open http://localhost:8787  
**Rebuild manifest:** `npm run docs:build-index`  
**Refresh route inventory:** `npm run docs:inventory`  
**Reorganize (already applied):** `node scripts/reorganize-docs-library.cjs`

> School staff duty label **DOS** (Director of Studies) is unrelated — that lives in school ERP duties.

---

## How to access

| Method | Steps |
|--------|--------|
| **Web interface** | `npm run docs:serve` → browse, search, filter, **🖨 Print**, hide/show sidebar |
| **Direct files** | Open any `.md` under the folders below (printer-friendly markdown) |
| **Deep link** | `http://localhost:8787/#doc=platform-platform-update-2026-09` (IDs from hub) |
| **Production DOS** | https://odelpay.vercel.app/docs |
| **DOCS/PUBLIC** | `/docs/public`, `/docs/public/overview`, … |
| **DOC/MACK** | `/admin/master#doc-mack` |
| **Legacy paths** | Root stubs like `docs/PARTNER_API.md` redirect to the new folder path |

---

## Folder layout (canonical)

| Folder | Contents |
|--------|----------|
| [`platform/`](./platform/) | OPGB provider, credentials, partner API, Uwais roadmap, developer ecosystem |
| [`guides/`](./guides/) | Role-based user guides |
| [`flows/`](./flows/) | User / admin / master / multi-tenant flows |
| [`school/`](./school/) | School admin, fees, admission, receipts, registration |
| [`architecture/`](./architecture/) | Structure, payment architecture, UI↔codebase |
| [`deployment/`](./deployment/) | Vercel, Telegram, webhooks, LivePay/Relworx/VixonPay |
| [`operations/`](./operations/) | Security, backup, hardening |
| [`economics/`](./economics/) | UGX / TON / FX · monetization research |
| [`product/`](./product/) | Project description, audits, backlog, stories |
| [`api-reference/`](./api-reference/) | OpenAPI + inventory CSVs |
| [`upstream-ura-pearl/`](./upstream-ura-pearl/) | Upstream Pearl runbooks |
| [`upstream-ura-game/`](./upstream-ura-game/) | Upstream game docs |
| [`contract-build/`](./contract-build/) | Contract build notes |

Root keeps: `index.html`, `README.md`, `LIBRARY.md`, `.nojekyll`, and **stub redirects** for old flat paths.

---

## Library features (hub)

- Real-time search  
- Category filters  
- Hideable sidebar (persisted in `localStorage`)  
- One-click print (print CSS strips chrome)  
- Mobile responsive layout  
- Stats: document count + size KB  
- Mermaid diagrams in markdown  

---

## Key entry docs

| Doc | Path |
|-----|------|
| 2 Nov 2026 release note | [`platform/PLATFORM_UPDATE_2026-11-02.md`](./platform/PLATFORM_UPDATE_2026-11-02.md) — product roots `/ODEI-OS` · `/ODELPay` · `/AssessmentVerseOS` · AVOS staff/student CSV IO · School Agent login · Pay Team University shell SSOT |
| 7 Nov 2026 Pay Team desks | [`guides/USER_GUIDE_PAY_TEAM_UNIVERSITY.md`](./guides/USER_GUIDE_PAY_TEAM_UNIVERSITY.md) · [`Pay_Team_University_App/docs/TEAM_DOORS_AND_DESKS.md`](../Pay_Team_University_App/docs/TEAM_DOORS_AND_DESKS.md) — TEAM doors each with dashboard + sidebar; Admin ≠ `/mac` |
| Higher Admin roles | [`school/SCHOOL_ADMIN_ROLES.md`](./school/SCHOOL_ADMIN_ROLES.md) · [`guides/USER_GUIDE_ADMIN_HIGHER.md`](./guides/USER_GUIDE_ADMIN_HIGHER.md) — overall TEAM University Admin + role categories |
| 11 Oct 2026 release note | [`platform/PLATFORM_UPDATE_2026-10-11.md`](./platform/PLATFORM_UPDATE_2026-10-11.md) — `/workspace` universe · four teacher stages · one email, many workspaces · dated classes · academic-year fee ledgers · higher pay any amount |
| Sep 2026 verify pack | [`platform/PLATFORM_VERIFY_2026-09-09.md`](./platform/PLATFORM_VERIFY_2026-09-09.md) |
| Sep 2026 update pack (commands · URLs · UI · policies) | [`platform/PLATFORM_UPDATE_2026-09.md`](./platform/PLATFORM_UPDATE_2026-09.md) — **last updated 2026-09-16** |
| 5 Oct 2026 release note | [`platform/PLATFORM_UPDATE_2026-10-05.md`](./platform/PLATFORM_UPDATE_2026-10-05.md) — Token desk auto-approve / auto-post / stock messages · Master lists from a contract address · students grouped by academic year · Build with AI on Pay links |
| 4 Oct 2026 release note | [`platform/PLATFORM_UPDATE_2026-10-04.md`](./platform/PLATFORM_UPDATE_2026-10-04.md) — Token desk (Tron tokens for MoMo / OPGB card) · Points API · Telegram command buttons · Community points · TON-only policy |
| Telegram + OpenPayGB complete guide | [`guides/ODELPAY_TELEGRAM_AND_OPGB_GUIDE.md`](./guides/ODELPAY_TELEGRAM_AND_OPGB_GUIDE.md) — bot, Mini App, points, token desk |
| 3 Oct 2026 release note | [`platform/PLATFORM_UPDATE_2026-10-03.md`](./platform/PLATFORM_UPDATE_2026-10-03.md) — platform charges · running term · Higher Register / Bills / Fee ledger · OPGB desk · School Code policy · Telegram + MongoDB hardening |
| 17 Sep 2026 holistic sync | [`platform/PLATFORM_UPDATE_2026-09-17.md`](./platform/PLATFORM_UPDATE_2026-09-17.md) — OPGB/ODEI hierarchy · Planned modules · Dex all-users · Mongo map · backlog |
| Holistic scan 17 Sep 2026 | [`product/HOLISTIC_SCAN_2026-09-17.md`](./product/HOLISTIC_SCAN_2026-09-17.md) — UI vs code · gaps · Mongo · deploy readiness |
| Theme library + PWA (17 Sep 2026) | [`platform/THEME_AND_PWA_2026-09-17.md`](./platform/THEME_AND_PWA_2026-09-17.md) — Light default · hub ThemeSwitcher · installable PWA |
| 16 Sep 2026 release note | [`platform/PLATFORM_UPDATE_2026-09-16.md`](./platform/PLATFORM_UPDATE_2026-09-16.md) — policies +2 · Help/Copilot · TMA school fees · monthly activation · footer catalog |
| OpenPayGB consumer + merchant guide | [`guides/USER_GUIDE_OPENPAYGB.md`](./guides/USER_GUIDE_OPENPAYGB.md) |
| Vertical adoption (events · travel · hospitality · logistics · delivery) | [`product/VERTICAL_ADOPTION_EVENTS_TRAVEL_HOSPITALITY_LOGISTICS_2026-09-17.md`](./product/VERTICAL_ADOPTION_EVENTS_TRAVEL_HOSPITALITY_LOGISTICS_2026-09-17.md) |
| ODEI OS capabilities & gaps (skins · devices · Business folders) | [`architecture/ODEI_OS_CAPABILITIES_AND_GAPS_2026-09-18.md`](./architecture/ODEI_OS_CAPABILITIES_AND_GAPS_2026-09-18.md) |
| OPGB Stars | [`platform/OPGB_STARS.md`](./platform/OPGB_STARS.md) |
| ODEI OS (skins + switcher) | [`architecture/ODEI_OS.md`](./architecture/ODEI_OS.md) |
| ODEI OS taskbar investigation (iOS + Windows) | [`architecture/ODEI_OS_TASKBAR_INVESTIGATION_2026-09-17.md`](./architecture/ODEI_OS_TASKBAR_INVESTIGATION_2026-09-17.md) |
| Ads platform + advertiser analytics | [`platform/ADS_PLATFORM_PLAN.md`](./platform/ADS_PLATFORM_PLAN.md) |
| School Administration roles | [`school/SCHOOL_ADMIN_ROLES.md`](./school/SCHOOL_ADMIN_ROLES.md) |
| Programmes (school + higher) | [`school/SCHOOL_ADMIN_PROGRAMMES.md`](./school/SCHOOL_ADMIN_PROGRAMMES.md) |
| Local credentials | [`platform/LOCAL_DEV_AND_CREDENTIALS.md`](./platform/LOCAL_DEV_AND_CREDENTIALS.md) |
| OPGB payment provider | [`platform/OPENPAYGB_PAYMENT_PROVIDER.md`](./platform/OPENPAYGB_PAYMENT_PROVIDER.md) |
| Partner API | [`platform/PARTNER_API.md`](./platform/PARTNER_API.md) |
| Higher / Schools monetization | [`economics/ODELPay_HIGHER_SCHOOLS_MONETIZATION.md`](./economics/ODELPay_HIGHER_SCHOOLS_MONETIZATION.md) |
| Header, footer, mobile nav | [`architecture/FOOTER_AND_HEADER_NAV.md`](./architecture/FOOTER_AND_HEADER_NAV.md) |
| Ecosystem monetization research | [`economics/ECOSYSTEM_MONETIZATION_RESEARCH.md`](./economics/ECOSYSTEM_MONETIZATION_RESEARCH.md) |
| User guide index | [`guides/USER_GUIDE_INDEX.md`](./guides/USER_GUIDE_INDEX.md) · [HTML hub](./guides/index.html) · regenerate `npm run docs:guides-html` |
| ODEI School Agent | [`guides/USER_GUIDE_SCHOOL_AGENT.md`](./guides/USER_GUIDE_SCHOOL_AGENT.md) · [HTML](./guides/USER_GUIDE_SCHOOL_AGENT.html) · `/help/guide-school-agent` |
| Access surfaces (product doors) | [`architecture/ACCESS_SURFACES.md`](./architecture/ACCESS_SURFACES.md) |
| Parent portal | [`guides/USER_GUIDE_PARENT.md`](./guides/USER_GUIDE_PARENT.md) |
| Dex (all users) | [`guides/USER_GUIDE_DEX.md`](./guides/USER_GUIDE_DEX.md) |
| Production go-live | [`deployment/PRODUCTION_GO_LIVE.md`](./deployment/PRODUCTION_GO_LIVE.md) |
| Docs README | [`README.md`](./README.md) |

**Production:** https://odelpay.vercel.app