Knock Knock — Internal Docs
The internal handbook for the whole company — product, sales, management, QA,
support, and engineering. It documents every module of the platform in depth: what
each feature does, how it works, every setting and behavior, plan availability, and
the technical implementation behind it. For the customer-facing product docs,
see docs.knockknockapp.ai (the docs-site repo).
This site documents implementation detail, infrastructure layout, secrets management, and integration internals. Do not expose it publicly or share with customers.
Find your track
| If you're in… | Start with |
|---|---|
| Sales / Management | Product Modules — capabilities, plan availability, and how each feature works in plain language. |
| QA / Support | Product Modules — each page's Configuration & options and Behaviors & edge cases sections document every setting and expected behavior. |
| Engineering | Architecture Overview, then Services and Subsystems. |
| New to the company | The Platform Overview (what we do) and, for engineers, New Engineer. |
Every Product Module page is written for mixed audiences: it opens with a plain-language summary, then covers how it works, every configuration option, behaviors and edge cases, plan limits, and a technical-implementation section that links to the engineering deep-dives.
What Knock Knock is
A multi-tenant SaaS visitor-engagement platform. A small JavaScript widget embeds on a customer's website and lets visitors chat, take audio/video calls, or talk to an AI voice agent. Everything visitors do is recorded (rrweb), scored, identity-resolved across sessions, and surfaced to the customer's team in a dashboard — plus an admin AI assistant (Nox/Knox) that answers questions and takes actions in connected CRMs.
See the Platform Overview for the product picture, or the Architecture Overview for the engineering picture.
How this site is organized
| Section | For | Contents |
|---|---|---|
| Product Modules | everyone | Every feature area documented in depth — widget, communication, AI agents, sessions, leads, identity, integrations, billing, settings, agency, desktop, Nox, data model. |
| Getting Started | engineers | Onboarding, local development, conventions. |
| Architecture | engineers | Service map, cross-service flows, data stores. |
| Services | engineers | One page per deployable service. |
| Subsystems | engineers | Cross-service feature internals (identity graph, Nox, recording, RAG, CRM sync). |
| Infrastructure | engineers / ops | Deployment, CI/CD, observability. |
The platform at a glance
| Layer | Repos | Stack |
|---|---|---|
| Client apps | widget, frontend, desktop | Vue 3 + Vite (widget embeds on customer sites; desktop is the dashboard packaged with Electron) |
| Core API | backend | Express + MongoDB on the in-house Nodevel framework |
| Realtime microservices | ms-communication, ms-sessions | Nodevel + MongoDB + Redis + Socket.IO |
| AI service | ms-ai | NestJS + Postgres/pgvector + BullMQ + multi-model LLMs |
| Knowledge | nox-knowledge-base | Markdown, ingested into ms-ai's RAG store |
| Infra / GitOps | flux-deployments | FluxCD + Kustomize + Helm on Kubernetes |
Keeping these docs honest
Each doc area is written against a known commit of its source repo, tracked in
.docs-sync.json. Before a documentation pass, run scripts/list-doc-changes.sh
to see what changed in each service since the last update. See the repo README for
the workflow.