Skip to main content

Docs Site (app-doc)

app-doc is the existing Docusaurus documentation site.

Responsibilities

  • Role/user manuals
  • API documentation
  • Engineering onboarding documentation
  • Architecture and evolution docs

Important files

  • app-doc/package.json
  • app-doc/package-lock.json
  • app-doc/docusaurus.config.ts
  • app-doc/sidebars.ts
  • app-doc/docs
  • app-doc/src
  • app-doc/Dockerfile

Commands

npm run docs:dev
npm run docs:typecheck
npm run docs:build

Direct equivalents:

npm --prefix app-doc run start
npm --prefix app-doc run typecheck
npm --prefix app-doc run build

The docs container is wired into docker-compose.yml as service docs and is exposed locally on DOCS_PORT, default 3002.