Skip to content

Docs: add Docker Compose runtime guide#247

Merged
smithaldon1 merged 1 commit into
mainfrom
docs/issue-234-compose-runtime-docs
May 27, 2026
Merged

Docs: add Docker Compose runtime guide#247
smithaldon1 merged 1 commit into
mainfrom
docs/issue-234-compose-runtime-docs

Conversation

@smithaldon1

Copy link
Copy Markdown
Member

Summary

  • Adds docs/runtime/DOCKER_COMPOSE.md with Docker Compose startup, shutdown, rebuild, logs, health-check, reset, expected URL, and safety guidance.
  • Adds docs/runtime/TROUBLESHOOTING.md for Docker daemon, Demo-Factory, port conflict, Postgres, connector, API, and Workbench failures.
  • Links the runtime docs from README, development/testing docs, Workbench docs, and service READMEs.
  • Adds doc regression coverage for the required commands, URLs, dependency order, troubleshooting topics, down versus down -v, and read-only safety boundary.

Closes #234

Test evidence

  • .venv/bin/python -m pytest services/simulator/tests/test_docker_compose_runtime_docs.py services/simulator/tests/test_runtime_docs_transition.py - 9 passed
  • Required docs search: rg -n "docker compose -f infra/docker/docker-compose.yml (up --build|ps|logs -f|down|down -v|config)|cd ../Demo-Factory|curl http://localhost:8000/health" README.md docs/runtime docs/DEVELOPMENT.md docs/TESTING.md apps/web/README.md services - commands present
  • docker compose -f infra/docker/docker-compose.yml config - passed
  • git diff --check - passed
  • make test - 257 passed
  • make lint - passed
  • make typecheck - passed
  • cd apps/web && npm test - 18 passed
  • make docs - passed; docs checker not configured yet
  • cd apps/web && npm run lint - passed
  • cd apps/web && npm run typecheck - passed
  • cd apps/web && npm run build - passed

Docs impact

  • Adds the new runtime docs under docs/runtime/ and updates required docs/service READMEs to point to them.
  • Adds a learning-log entry explaining the Docker Compose runtime documentation and command baseline.

Follow-up work

@smithaldon1 smithaldon1 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed and approved for merge

@smithaldon1 smithaldon1 merged commit 3db4ca2 into main May 27, 2026
3 checks passed
@smithaldon1 smithaldon1 deleted the docs/issue-234-compose-runtime-docs branch May 27, 2026 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Task: Add Docker Compose runtime documentation

1 participant