Skip to content

uEngage Engineering Knowledge Base

A single, searchable home for product-by-product engineering knowledge across the uEngage platform. Each product has its own deep-dive knowledge base — architecture, modules, database, APIs, runbooks, and a full learning path — grounded in the actual code, not generic descriptions.

📚 Products

Product What it is Status Enter
Prism F&B customer-engagement / CRM platform (dashboards, RFM, campaigns, loyalty, membership, feedback) 🟢 Complete Open Prism KB →
WLA White-Label App ⚪ Planned coming soon
Edge uEngage Edge — online ordering platform ⚪ Planned coming soon

Adding a product later is just a new folder under docs/ (e.g. docs/wla/) plus a nav section — see Adding a new product.

🚀 How to use this KB

  • Reading on GitHub? Just browse the folders — everything renders as Markdown with diagrams.
  • Reading as a website? Run the MkDocs portal (full-text search, rendered diagrams, dark mode): from the repo root, pip install -r requirements-docs.txt then mkdocs serve → http://127.0.0.1:8000. Full instructions are in the repository README.
  • New joiner? Pick your product and start with its Getting Started section and New Joiner Learning Path.
  • AI / RAG? Every page carries YAML front-matter (tags, keywords, related, difficulty, reading_time) for retrieval.

🧭 Conventions (shared across all products)

Every product KB follows the same shape so knowledge is predictable wherever you land:

docs/<product>/
├── README.md              # product master index
├── 00-Getting-Started/    # system overview, setup, project structure
├── 01-Business/           # product + business flows, glossary, roadmap
├── 02-Architecture/       # high-level, request lifecycle, module map
├── 03-Modules/            # per-module 15-section deep-dives
├── 04..13/                # Database, API, Queues, Caching, Security,
│                          # Third-Party, Deployment, Debugging,
│                          # Best-Practices, Common-Issues
└── 14..15/                # Interview questions, learning path, assessments

Validation legend (used in every product KB): ✅ verified in code · 📄 spec-only · 💻 code-only · ♻️ duplicate impl · ⚰️ dead/legacy · ⚠️ tech debt / risk.

➕ Adding a new product

  1. Create docs/<product>/ following the folder shape above (copy Prism's skeleton as a template).
  2. Add a nav section for it in mkdocs.yml (a new top-level entry becomes a tab).
  3. Add a row to the Products table above.
  4. Build with mkdocs build --strict to verify links.

Start here → Prism Knowledge Base