Appearance
Documentation Registry
This file is the canonical catalog of documentation files.
Agents and contributors must read this file first before creating or editing docs.
Usage Rules
- Reuse existing docs when possible.
- Update this registry in the same change whenever docs are created, renamed, superseded, or deleted.
- Keep one active source of truth per topic.
Status Legend
active: current source of truth.draft: work in progress.superseded: replaced by a newer document.archived: historical reference only.
Catalog
Core
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/index.md | Home | active | platform-engineering | Docs portal |
apps/docs/registry.md | Registry | active | platform-engineering | Canonical docs index |
Architecture
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/architecture/overview.md | Architecture | active | api-team | High-level architecture map |
apps/docs/architecture/api-module-architecture.md | Architecture | active | api-team | API module dependency graph and DDD layers |
ADR
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/adr/index.md | ADR Index | active | api-team | Entry point for ADRs |
apps/docs/adr/001-mapproperties-rounding-token-cost-precision.md | ADR | active | api-team | Token cost precision |
apps/docs/adr/002-token-usage-pessimistic-locking.md | ADR | active | api-team | Locking strategy |
apps/docs/adr/003-full-response-storage-strategy.md | ADR | active | api-team | Response storage strategy |
apps/docs/adr/004-module-self-containment-architecture.md | ADR | active | api-team | Module self-containment |
apps/docs/adr/005-integration-events-publisher-consumer.md | ADR | active | api-team | Integration events publisher/consumer pattern |
Features - API
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/features/api/index.md | Feature Index | active | api-team | API feature map |
apps/docs/features/api/ai/agent-brain-fallback-model.md | Feature | active | api-team | AI fallback model |
apps/docs/features/api/ai/agent-limits-config.md | Feature | active | api-team | AI limits configuration |
apps/docs/features/api/ai/chat-interaction-cache.md | Feature | active | api-team | Chat caching behavior |
apps/docs/features/api/ai/rag-knowledge-system.md | Feature | active | api-team | RAG knowledge flow |
apps/docs/features/api/ai/token-consumption-tracking.md | Feature | active | api-team | Token accounting |
apps/docs/features/api/ai/sql/agent-stats-maintenance.md | Feature Support | active | api-team | SQL maintenance process |
apps/docs/features/api/ai/sql/rebuild-agent-stats.sql | SQL Asset | active | api-team | Rebuild script |
apps/docs/features/api/auth/abac-explanation.md | Feature | active | api-team | ABAC behavior |
apps/docs/features/api/auth/agency-access-breaking-changes.md | Feature | active | api-team | Access behavior changes |
apps/docs/features/api/auth/email-verification-activation-flow.md | Feature | active | api-team | Activation rules for email/password vs Google login |
apps/docs/features/api/auth/identity-auth-service-ports.md | Feature | active | api-team | Application-layer service contracts for identity auth services |
apps/docs/features/api/auth/result-pattern-error-handling.md | Feature | active | api-team | Result pattern with structured bilingual errors |
apps/docs/features/api/auth/typed-app-config-service.md | Feature | active | api-team | Typed env access and startup validation |
apps/docs/features/api/file-gateway/claim-token-upload.md | Feature | active | api-team | Upload claim tokens |
apps/docs/features/api/file-gateway/file-upload-rpc-auth.md | Feature | active | api-team | File gateway auth |
Features - Other Apps
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/features/panel/index.md | Feature Index | draft | panel-team | Panel docs placeholder |
apps/docs/features/infra/index.md | Feature Index | draft | platform-engineering | Infra feature placeholder |
Workflows
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/workflows/engineering/overview.md | Workflow Index | active | platform-engineering | Engineering workflows |
apps/docs/workflows/engineering/api-import-aliases.md | Workflow | active | api-team | API internal import alias conventions |
apps/docs/workflows/engineering/api-zod-request-validation.md | Workflow | active | api-team | API body validation pattern with shared Zod schemas |
apps/docs/workflows/engineering/documentation-guidelines.md | Workflow | active | platform-engineering | Docs writing conventions |
apps/docs/workflows/engineering/deploy-workflow.md | Workflow | active | platform-engineering | CI/CD pipeline: Docker Hub + Dokploy |
apps/docs/workflows/engineering/how-to-run-tests.md | Workflow | active | api-team | Test execution workflow |
apps/docs/workflows/engineering/local-development-traefik.md | Workflow | active | platform-engineering | Traefik local setup |
apps/docs/workflows/operations/overview.md | Workflow Index | draft | platform-engineering | Operations workflows placeholder |
Runbooks
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/runbooks/infra/overview.md | Runbook Index | draft | platform-engineering | Infra runbooks placeholder |
apps/docs/runbooks/observability/index.md | Runbook Index | active | platform-engineering | Observability baseline |
apps/docs/runbooks/observability/container-metrics.md | Runbook | active | platform-engineering | Container metrics |
apps/docs/runbooks/observability/grafana.md | Runbook | active | platform-engineering | Grafana operations |
apps/docs/runbooks/observability/ia-integration.md | Runbook | active | platform-engineering | IA service telemetry integration |
apps/docs/runbooks/observability/local-setup.md | Runbook | active | platform-engineering | Local observability stack |
apps/docs/runbooks/observability/loki-tempo-prometheus.md | Runbook | active | platform-engineering | LGTM integration |
apps/docs/runbooks/observability/wide-logs.md | Runbook | active | platform-engineering | Wide log strategy |
Domains
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/domains/api/domain-entity-lifecycle.md | Domain Doc | active | api-team | Entity encapsulation and mutation patterns |
apps/docs/domains/api/transactions/concurrency-and-locking.md | Domain Doc | active | api-team | Concurrency strategy |
apps/docs/domains/api/transactions/transaction-quick-reference.md | Domain Doc | active | api-team | Quick reference |
apps/docs/domains/api/transactions/transaction-system.md | Domain Doc | active | api-team | Transaction model |
apps/docs/domains/api/transactions/understanding-transaction-system.md | Domain Doc | active | api-team | Deep dive |
apps/docs/domains/api/crm/company-socials/insta-face-whatsapp.txt | Domain Asset | active | api-team | CRM reference data |
apps/docs/domains/api/crm/company-socials/socials-objects.txt | Domain Asset | active | api-team | CRM reference data |
apps/docs/domains/panel/overview.md | Domain Overview | draft | panel-team | Panel domain placeholder |
apps/docs/domains/packages/overview.md | Domain Overview | draft | platform-engineering | Shared packages placeholder |
apps/docs/domains/infra/overview.md | Domain Overview | active | platform-engineering | Infra domain map |
apps/docs/domains/infra/dokploy-platform.md | Domain Doc | active | platform-engineering | Dokploy project structure and configuration |
Legacy / Superseded
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/legacy/superseded/overview.md | Legacy Index | superseded | platform-engineering | Legacy map |
apps/docs/legacy/superseded/api-examples.md | Legacy Doc | superseded | platform-engineering | Replaced by typed feature docs |
apps/docs/legacy/superseded/markdown-examples.md | Legacy Doc | superseded | platform-engineering | VitePress sample content |
apps/docs/legacy/superseded/discount-buy-x-get-y.md | Legacy Doc | superseded | api-team | Historical behavior |
apps/docs/legacy/superseded/discount-category-or-product.md | Legacy Doc | superseded | api-team | Historical behavior |
apps/docs/legacy/superseded/discount-shipping.md | Legacy Doc | superseded | api-team | Historical behavior |
apps/docs/legacy/superseded/discounts-architecture.md | Legacy Doc | superseded | api-team | Historical architecture |
apps/docs/legacy/superseded/discounts.md | Legacy Doc | superseded | api-team | Historical behavior |
apps/docs/legacy/superseded/elavon.md | Legacy Doc | superseded | api-team | Historical integration |
apps/docs/legacy/superseded/nmi.md | Legacy Doc | superseded | api-team | Historical integration |
apps/docs/legacy/superseded/microservices/Dead Letter Queues.md | Legacy Doc | superseded | platform-engineering | Historical microservice pattern |
apps/docs/legacy/superseded/recharges/queue-based-processing-implementation.md | Legacy Doc | superseded | api-team | Historical queue implementation |
apps/docs/legacy/superseded/shops/cart-orders-flow.md | Legacy Doc | superseded | api-team | Historical flow |
apps/docs/legacy/superseded/shops/cart-resume.md | Legacy Doc | superseded | api-team | Historical flow |
Templates
| Path | Type | Status | Owner | Notes |
|---|---|---|---|---|
apps/docs/templates/adr-template.md | Template | active | platform-engineering | New ADR template |
apps/docs/templates/feature-template.md | Template | active | platform-engineering | New feature doc template |
apps/docs/templates/workflow-template.md | Template | active | platform-engineering | New workflow template |
apps/docs/templates/runbook-template.md | Template | active | platform-engineering | New runbook template |
Recently Changed Docs
- 2026-02-26: Added domain entity lifecycle documentation with encapsulation and mutation patterns.
- 2026-02-26: Added identity email verification activation flow rules for users and clients.
- 2026-02-26: Added API Zod request validation workflow and indexed it under engineering workflows.
- 2026-02-26: Added API import aliases workflow and indexed it under engineering workflows.
- 2026-02-26: Restructured docs into
architecture,features,workflows,runbooks,domains, andlegacy/superseded. - 2026-02-26: Added root
AGENTS.mdwith mandatory docs update workflow. - 2026-02-26: Added templates for ADR, feature, workflow, and runbook docs.
- 2026-02-26: Added identity auth service port documentation and registry entry.
- 2026-02-26: Added Result pattern and structured error handling feature doc.
- 2026-02-27: Added ADR 004 — Module self-containment architecture (CoreModule, SharedModule, feature-owned data sources).
- 2026-02-27: Added API module architecture doc with mermaid dependency graphs and data flow diagrams.
- 2026-02-27: Created missing index files for
features/api/andrunbooks/observability/(fixed pre-existing dead links). - 2026-02-27: Added ADR 005 — Integration events publisher/consumer pattern (removed cross-module identity→notifications coupling).
- 2026-02-28: Added deployment workflow doc (CI/CD pipeline with Docker Hub and Dokploy).
- 2026-03-01: Updated deploy-workflow Dockerfile snippets to match actual infra/apps/ Dockerfiles (global turbo, corepack-only pnpm, git for docs, no NODE_ENV).
- 2026-03-01: Updated deploy workflow to support two environments (Production from
main, Development fromdevelop) with environment-scoped secrets and dynamic tag prefixes. - 2026-03-01: Added Dokploy platform setup doc (project structure, resource types, manual configuration).
Known Documentation Gaps
- Panel feature documentation is still placeholder-level.
- Infra runbooks beyond observability are not yet documented.
- Some legacy docs are preserved without explicit replacement docs and should be migrated gradually.