Skip to content

Task: Remove simulator-facing docs and prompts #233

Description

@smithaldon1

Parent Epic

#232

Purpose

Remove or replace documentation and Codex prompts that present the in-repo simulator as the default Factory Intelligence Platform development or demo path.

Demo-Factory is now the separate source/simulation repo. FIP documentation should describe consuming external Demo-Factory protocol data through read-only connectors.

Acceptance Criteria

  • services/simulator/README.md is deleted or replaced with a short pointer that the simulator has moved out of the default FIP runtime.
  • docs/DEMO_RUNBOOK.md is deleted or replaced by Docker/Demo-Factory runtime docs.
  • Simulator-specific demo docs under docs/demo/ are deleted, merged into new runtime docs, or rewritten so they no longer describe simulator-backed in-repo setup.
  • prompts/03-synthetic-factory-simulator.md is replaced with a Docker/external-source runtime prompt.
  • README.md, docs/START_HERE_FOR_CODEX.md, docs/MVP_SCOPE.md, docs/DEVELOPMENT.md, and FILE_INDEX.md no longer present in-repo simulation as the default implementation path.
  • docs/LEARNING_LOG.md keeps historical entries but gains a new entry explaining the shift to Docker Compose and external Demo-Factory sources.
  • Doc-regression tests that enforce simulator wording are removed or rewritten around Docker Compose and Demo-Factory integration.

Out of Scope

  • Deleting production code or tests solely to make docs pass.
  • Removing historical learning-log entries.
  • Implementing Docker services or storage changes; those are separate child issues.

Validation

Run searches and ensure remaining matches are historical or intentionally scoped:

rg -n "simulator|simulator-backed|make demo-data|make simulate|opcua-simulator" README.md docs apps services packages Makefile pyproject.toml

Run relevant tests:

make test
cd apps/web && npm test

Safety Boundary

Do not replace simulator docs with claims of production readiness. The new docs must still state that FIP is read-only by default and does not perform industrial writeback, product disposition, or QMS/MES writeback.

Metadata

Metadata

Assignees

No one assigned

    Labels

    TaskdocumentationDocumentation workpost-demoNot required for the manufacturer demo path

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions