Skip to content

docs: archive simulator planning (closes #224)#228

Merged
tylerkron merged 1 commit into
mainfrom
chore/archive-simulator-docs-224
May 24, 2026
Merged

docs: archive simulator planning (closes #224)#228
tylerkron merged 1 commit into
mainfrom
chore/archive-simulator-docs-224

Conversation

@tylerkron
Copy link
Copy Markdown
Contributor

Summary

The history is preserved (these are git mv renames, not deletes) so a future revival has the design material one click away. No src/ changes; no references to the old path existed elsewhere in the repo.

Closes #224.

Test plan

  • Click into docs/archive/simulator/ from GitHub and confirm the README makes the archived status obvious before any planning content.
  • Verify the four file links in the README resolve.
  • grep -rn "docs/simulator" in the tree returns nothing.

🤖 Generated with Claude Code

The C# native device simulator scoped in 2025 (#61-#66) was never built,
and the HIL smoke test in #219 supersedes its role. Move the four planning
documents under docs/archive/simulator/ and add a README clarifying their
status so readers don't infer a simulator exists somewhere in src/.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tylerkron tylerkron requested a review from a team as a code owner May 24, 2026 00:03
@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Archive simulator planning documentation with status clarification

📝 Documentation

Grey Divider

Walkthroughs

Description
• Archive simulator planning docs under docs/archive/simulator/
• Add README clarifying archived status and design rationale
• Preserve git history for potential future revival
• Prevent confusion about simulator implementation status
Diagram
flowchart LR
  A["docs/simulator/<br/>planning files"] -- "git mv<br/>archived" --> B["docs/archive/simulator/<br/>planning files"]
  B -- "new" --> C["README.md<br/>status clarification"]
  C -- "explains" --> D["Simulator planned 2025<br/>never implemented"]
  D -- "superseded by" --> E["HIL smoke test<br/>PR #219"]

Loading

File Changes

1. docs/archive/simulator/README.md 📝 Documentation +12/-0

Add archived simulator status documentation

• New README file explaining archived status of simulator planning
• Clarifies simulator was scoped in 2025 but never implemented
• Documents that HIL smoke test in PR #219 superseded its role
• Lists four planning documents with brief descriptions and links

docs/archive/simulator/README.md


2. docs/archive/simulator/GITHUB_ISSUES.md Additional files +0/-0

...

docs/archive/simulator/GITHUB_ISSUES.md


3. docs/archive/simulator/PLANNING_SUMMARY.md Additional files +0/-0

...

docs/archive/simulator/PLANNING_SUMMARY.md


View more (2)
4. docs/archive/simulator/SIMULATOR_DESIGN.md Additional files +0/-0

...

docs/archive/simulator/SIMULATOR_DESIGN.md


5. docs/archive/simulator/SIMULATOR_IMPLEMENTATION_PLAN.md Additional files +0/-0

...

docs/archive/simulator/SIMULATOR_IMPLEMENTATION_PLAN.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

qodo-code-review Bot commented May 24, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@tylerkron tylerkron merged commit f9e4120 into main May 24, 2026
1 check passed
@tylerkron tylerkron deleted the chore/archive-simulator-docs-224 branch May 24, 2026 00:51
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.

docs: remove or archive stale simulator planning docs

1 participant