Skip to content

Zwerfkei Documentation

Welcome to the Zwerfkei Documentation Repository.
This repository provides centralised documentation for all Zwerfkei services and applications. It is intended as the single source of truth for developers, engineers, and stakeholders.

Purpose

  • To document the architecture, APIs, workflows, and integrations of all Zwerfkei platforms.
  • To provide consistent guidelines and best practices across all services.
  • To help onboard new developers quickly and efficiently.

Repository Structure

/
│
├── README.md                    → About this documentation repo (purpose, structure, contributors)
│
├── overview.md                  → General architecture overview / high-level service diagram
│
├── services/
│   ├── zwerfkei-cms/
│   │   ├── README.md            → What this service does
│   │   ├── setup.md             → Installation & environment setup
│   │   ├── api.md               → API specifications
│   │   └── changelog.md         → Release information & version history
│   │
│   ├── zwerfkei-backend/
│   └── zwerfkei-website/
│
├── features/
│   ├── XXXX.md
│   └── XXXX.md
│
├── tools/                      → External tools & services documentation
│   ├── cloudflare/
│   ├── ga4/
│   ├── github/
│   ├── google-tag-manager/
│   ├── ms-dynamics-navision/
│   └── google-tag-manager/
│
└── diagrams/
    ├── architecture.mmd         → Mermaid diagram: system & service relations
    ├── workflows.mmd            → Mermaid diagram: example process flows
Folder Description
/services Contains documentation for individual services (CMS, Website, APIs, etc.).
/features Contains big features of all services created by the platform
/shared Contains general guidelines, logging standards, security policies, etc.
/tools Contains documentation for external tools and services used by Zwerfkei.
/diagrams Contains architecture and workflow diagrams (Mermaid format).

List of Zwerfkei Services

  • Zwerfkei-cms
  • Zwerfkei-backend
  • Zwerfkei-website

Each service has its folder under /services/.

External Tools & Services

This section documents the external tools and services used by Zwerfkei. Each page provides a short description, what the tool does, and how we use it.