Last updated 2026-05-03

adb-doc

AI-generated content

This document was generated by an AI assistant. Verify accuracy before relying on the details.

Role

Technical and functional documentation site for the platform — that is, this site. Built with VuePress 2 (Markdown → static Vue 3 site).

Stack

Item	Value
VuePress	2.0.0-rc.7
Theme	`@vuepress/theme-default` 2.0.0-rc.11
Bundler	`@vuepress/bundler-vite`
Vue	3.4.0
Search	`@vuepress/plugin-search` 2.0.0-rc.30
Mermaid	`vuepress-plugin-md-enhance` + `mermaid` 11.4
Current hosting	AWS EC2 + Nginx
Target hosting	Cloudflare Pages (migration in progress)

Structure

adb-doc/
├── docs/
│   ├── index.md                  Table of contents
│   ├── architecture/             Overview (overview, communication, data, auth)
│   ├── services/                 Project pages (one per monorepo project)
│   ├── functional-epics/         Existing functional epics
│   ├── technical-epics/          Existing technical epics
│   ├── productBoard/             Product specs
│   ├── implicit/                 Implicit specs (callbacks, etc.)
│   ├── data-dictionary.md        Collection dictionary
│   ├── assets/                   Images, diagrams
│   └── .vuepress/
│       └── config.js             Site configuration (sidebar, plugins)
├── package.json                  Scripts + deps
├── bitbucket-pipelines.yml       Legacy CI/CD to EC2
└── readme.md

Sections

Architecture (new)

Cross-cutting overview of the monorepo:

Overview — global diagram + inventory.
Communication — inter-service patterns, FQDN, gateway, BFF, events.
Data — MongoDB, S3, Neo4j, messaging.
Auth — Keycloak, JWT, BFF.

Services (new)

A detailed page per project: services/.

Functional Epics (existing)

Business use cases, organised by domain: display, process, reporting, stateMachine, utility. See the index on the home page.

Technical Epics (existing)

Cross-cutting technical topics: environment, logging, tracing, OpenAPI, security, messaging, tests.

Product Board / Implicit

Product-oriented specs and notes (rental process, ticketing, callbacks).

Configuration

docs/.vuepress/config.js — VuePress configuration:

Theme: default with navbar (Architecture, Services, Swagger Docs).
Sidebar: structured per section (/architecture/, /services/).
Plugins:
- searchPlugin — full-text search.
- mdEnhancePlugin({ mermaid: true }) — Mermaid diagram rendering.

Build

npm install
npm run docs:dev            # Dev server (localhost:8080)
npm run docs:build          # Static build → docs/.vuepress/dist/
npm run docs:clean-dev      # Dev with cleared cache
npm run docs:update-package # Update VuePress

Deployment

Legacy: Bitbucket Pipelines → AWS EC2

bitbucket-pipelines.yml:

Build: Node 18 Alpine, npm install + npm run docs:build, artifact docs/.vuepress/dist/**.
Deploy: SSH to EC2 (SSH_PRIVATE_KEY, EC2_IP_ADDRESS), SCP to EC2_REMOTE_PATH, reload Nginx.

Target: Cloudflare Pages

Configuration planned (to be provisioned on the Cloudflare dashboard):

Build command: npm run docs:build
Output directory: docs/.vuepress/dist
Root directory: adb-doc/
Node version: 20
Branch: main (production), preview deploy per PR

Once Cloudflare Pages is operational, the Bitbucket pipeline will be deprecated.