Skip to content

Docs: remove simulator-first runtime docs#246

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

Docs: remove simulator-first runtime docs#246
smithaldon1 merged 1 commit into
mainfrom
docs/issue-233-runtime-docs-cleanup

Conversation

@smithaldon1

Copy link
Copy Markdown
Member

Summary

  • Replaces simulator-first runtime docs and prompt guidance with the Docker/Demo-Factory external-source runtime direction.
  • Rewrites simulator-specific demo docs and service READMEs to describe read-only connectors, FactoryEvent ingestion, Process Sentinel, API, and Workbench flow.
  • Replaces old simulator-wording doc regression tests with a runtime-direction regression test and updates related Workbench/OPC-UA assertions.

Closes #233

Test evidence

  • .venv/bin/python -m pytest services/simulator/tests/test_runtime_docs_transition.py services/simulator/tests/test_opcua_demo_server.py - 8 passed
  • npm test in apps/web - 18 passed
  • make test - 252 passed
  • make lint - passed
  • make typecheck - passed
  • make docs - passed; docs checker not configured yet
  • npm run lint in apps/web - passed
  • npm run typecheck in apps/web - passed
  • npm run build in apps/web - passed
  • docker compose -f infra/docker/docker-compose.yml config - passed
  • git diff --check - passed
  • Issue wording scan run: rg -n "simulator|simulator-backed|make demo-data|make simulate|opcua-simulator" README.md docs apps services packages Makefile pyproject.toml. Remaining hits are historical learning-log/ADR entries, legacy Makefile/code/test fixtures, and UI/runtime wording intentionally left for Task: Update API and Workbench runtime wording #240.

Docs impact

  • Current runtime docs now point contributors at Docker Compose plus external Demo-Factory protocol sources.
  • Historical learning-log entries were preserved and a new learning entry documents the direction shift.

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 395cca7 into main May 27, 2026
3 checks passed
@smithaldon1 smithaldon1 deleted the docs/issue-233-runtime-docs-cleanup branch May 27, 2026 00:09
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: Remove simulator-facing docs and prompts

1 participant