dohertj2/scadalink-design
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(docs): move requirements and test infra docs into docs/ subdirectories

Browse Source 
Organize documentation by moving requirements (HighLevelReqs, Component-*,
lmxproxy_protocol) to docs/requirements/ and test infrastructure docs to
docs/test_infra/. Updates all cross-references in README, CLAUDE.md,
infra/README, component docs, and 23 plan files.
This commit is contained in:
Joseph Doherty
2026-03-21 01:11:35 -04:00
parent 0a85a839a2
commit d91aa83665
52 changed files with 486 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/plans/2026-03-19-lmxfakeproxy-implementation.md
View File

@@ -1550,12 +1550,12 @@ git commit -m "feat(infra): add LmxFakeProxy Dockerfile and docker-compose servi
### Task 8: Documentation Updates
**Files:**
- Modify: `test_infra.md`
- Modify: `docs/test_infra/test_infra.md`
- Modify: `infra/README.md`
- Create: `test_infra_lmxfakeproxy.md`
- Modify: `Component-DataConnectionLayer.md`
- Create: `docs/test_infra/test_infra_lmxfakeproxy.md`
- Modify: `docs/requirements/Component-DataConnectionLayer.md`
**Step 1: Update test_infra.md**
**Step 1: Update docs/test_infra/test_infra.md**
Add a row to the Services table:
@@ -1566,7 +1566,7 @@ Add a row to the Services table:
Add a bullet to the per-service documentation list:
```
- [test_infra_lmxfakeproxy.md](test_infra_lmxfakeproxy.md) — LmxProxy fake server (OPC UA bridge)
- [test_infra_lmxfakeproxy.md](../test_infra/test_infra_lmxfakeproxy.md) — LmxProxy fake server (OPC UA bridge)
```
Update the Files section to add:
@@ -1583,7 +1583,7 @@ Add a row to the quick-start table:
| LmxFakeProxy (.NET gRPC) | 50051 (gRPC) | LmxProxy-compatible server bridging to OPC UA test server |
```
**Step 3: Create test_infra_lmxfakeproxy.md**
**Step 3: Create docs/test_infra/test_infra_lmxfakeproxy.md**
```markdown
# Test Infrastructure: LmxFakeProxy
@@ -1664,18 +1664,18 @@ dotnet run -- --api-key my-secret-key
- **Integration Tests** — End-to-end tests of the LmxProxy protocol path
```
**Step 4: Update Component-DataConnectionLayer.md**
**Step 4: Update docs/requirements/Component-DataConnectionLayer.md**
Add a note in the LmxProxy section (after the "Proto Source" paragraph, before "## Subscription Management"):
```markdown
**Test Infrastructure**: The `infra/lmxfakeproxy/` project provides a fake LmxProxy server that bridges to the OPC UA test server. It implements the full `scada.ScadaService` proto, enabling end-to-end testing of `RealLmxProxyClient` without a Windows LmxProxy deployment. See [test_infra_lmxfakeproxy.md](test_infra_lmxfakeproxy.md) for setup.
**Test Infrastructure**: The `infra/lmxfakeproxy/` project provides a fake LmxProxy server that bridges to the OPC UA test server. It implements the full `scada.ScadaService` proto, enabling end-to-end testing of `RealLmxProxyClient` without a Windows LmxProxy deployment. See [test_infra_lmxfakeproxy.md](../test_infra/test_infra_lmxfakeproxy.md) for setup.
```
**Step 5: Commit**
```bash
git add test_infra.md test_infra_lmxfakeproxy.md infra/README.md Component-DataConnectionLayer.md
git add docs/test_infra/test_infra.md docs/test_infra/test_infra_lmxfakeproxy.md infra/README.md docs/requirements/Component-DataConnectionLayer.md
git commit -m "docs: add LmxFakeProxy to test infrastructure documentation"
```