Skip to main content
Version: 3.2.0

feat-in-image-docs

✨ New Features​

[Operator docs in the image]​

Goal: Each Tower version ships matching operator documentation (install, configuration, operations, concepts) instead of a version-blind Notion page.

Solution: VitePress site in docs/user/ is built into the image. Nest serves it at /docs. docker run <image> docs starts a docs-only process (no volumes, no activation).

Features:

  • Operator guide (EN / FR) at https://<tower>/docs: Install, Configuration (including examples), Operations (including troubleshooting), Concepts
  • Docs-only command: docker run --rm -p 8080:80 <image> docs
  • Help in the sidenav points to /docs
  • Config reference for YAML sources and storage, plus complete examples

Implementation Details:

  • Isolated npm package under docs/user/ (VitePress is not a Nest dependency)
  • Static output copied to docs-site/ in the production image
  • docs-server.js uses Express already present in the image

Files Modified:

  • docs/user/ - VitePress operator documentation (EN/FR)
  • docs-server.js - docs-only HTTP server
  • entrypoint.sh - docs argument
  • docker/Dockerfile - docs build stage
  • src/app.module.ts - ServeStatic /docs
  • src/app.static-roots.ts - static root wiring
  • ui/src/components/layout/Sidenav.tsx - Help link
  • .gitlab-ci.yml - build:docs job