Developer Documentation
Documentation for engineers building and maintaining HUPH — a WhatsApp-native AI chatbot platform for UPH (Universitas Pelita Harapan) student admission.
-
Onboarding
From
git cloneto a working local stack in ~15 minutes. Repository tour, test setup, first PR conventions, debugging recipes. -
Architecture
System overview, API + admin deep-dives, Dify-based AI pipeline, integration matrix, audit catalog.
-
Operations
Deploy, rollback, incident playbook, ClickHouse OOM recovery, annotation re-indexing, smoke tests.
-
Zitadel SSO
Master-key custody, upgrade procedure, CVE response, backup/DR, monitoring, user provisioning, troubleshooting.
Onboarding sequence
- Setup — Local environment in ~15 minutes
- Repository tour — Monorepo layout
- Running tests — Jest (API) + admin verification
- Your first PR — Conventions, TDD, commit style, bilingual docs sync
- Debugging — Logs, Phoenix, Langfuse, common traps
Architecture deep-dives
- Overview — System diagram + data flow
- API — Node.js webhook + admin REST
- AI pipeline (Dify) — Chat completion +
KB retrieval (replaces the deleted Python
apps/rag) - Admin — Next.js enterprise dashboard
- Integrations — External services
- Audit catalog — Every audit action mapped to its writer + sample SQL
Operations runbooks
- Deploy — Manual deploy sequence
- Rollback — Rollback flow
- Incident playbook — Detect, triage, contain, fix, verify, postmortem
- ClickHouse OOM recovery
- Realtime smoke test
- Lead capture smoke test
- Annotation re-indexing
- Nginx realtime config
Language
Developer documentation is English source-of-truth. Bahasa
mirrors are not maintained for dev/. Operator guides
(guide/) are the inverse — Bahasa is source.