Docs: add Docker Compose runtime guide#247
Merged
Merged
Conversation
smithaldon1
commented
May 27, 2026
smithaldon1
left a comment
Member
Author
There was a problem hiding this comment.
Reviewed and approved for merge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/runtime/DOCKER_COMPOSE.mdwith Docker Compose startup, shutdown, rebuild, logs, health-check, reset, expected URL, and safety guidance.docs/runtime/TROUBLESHOOTING.mdfor Docker daemon, Demo-Factory, port conflict, Postgres, connector, API, and Workbench failures.downversusdown -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 passedrg -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 presentdocker compose -f infra/docker/docker-compose.yml config- passedgit diff --check- passedmake test- 257 passedmake lint- passedmake typecheck- passedcd apps/web && npm test- 18 passedmake docs- passed; docs checker not configured yetcd apps/web && npm run lint- passedcd apps/web && npm run typecheck- passedcd apps/web && npm run build- passedDocs impact
docs/runtime/and updates required docs/service READMEs to point to them.Follow-up work