Task #252 — docs/ index + parent doc for the driver CLI suite #206

2026-04-21T08:57:09-04:00

dohertj2 commented

2026-04-21 08:57:09 -04:00

Per-CLI runbooks shipped with #249-#251 but docs/README.md's Client tooling table never listed them + no parent doc tied the suite together.

Adds

docs/DriverClis.md — short parent. Index table, shared-commands callout, Driver.Cli.Common infrastructure note, typical cross-CLI workflows, known gaps cross-referencing per-CLI docs.
docs/README.md — Client tooling table grows 6 rows (DriverClis parent + 5 per-CLI). Also corrects Client.CLI.md row (otopcua-cli, not the stale lmxopcua-cli from pre-#208).

Docs-only, no code changes.

Per-CLI runbooks shipped with #249-#251 but `docs/README.md`'s Client tooling table never listed them + no parent doc tied the suite together. ## Adds - `docs/DriverClis.md` — short parent. Index table, shared-commands callout, Driver.Cli.Common infrastructure note, typical cross-CLI workflows, known gaps cross-referencing per-CLI docs. - `docs/README.md` — Client tooling table grows 6 rows (DriverClis parent + 5 per-CLI). Also corrects Client.CLI.md row (otopcua-cli, not the stale lmxopcua-cli from pre-#208). Docs-only, no code changes.

dohertj2 added 1 commit 2026-04-21 08:57:11 -04:00

Task #252 — docs/ index + parent doc for the driver CLI suite adce4e7727

Per-CLI runbooks (Driver.{Modbus,AbCip,AbLegacy,S7,TwinCAT}.Cli.md) shipped
with #249-#251 but docs/README.md's Client tooling table never grew entries
for them and there was no parent doc pulling the suite together.

Adds:
  - docs/DriverClis.md — short parent. Index table, shared-commands callout
    (probe / read / write / subscribe), Driver.Cli.Common infrastructure
    note (what's shared, marginal cost of adding a sixth CLI), typical
    cross-CLI workflows (commissioning, bug reproduction, recipe-write
    validation, byte-order debugging), known gaps that cross-ref the
    per-CLI docs (AB Legacy ab_server upstream gap, S7 PUT/GET enable,
    TwinCAT AMS router, UDT-write refusal), tracking pointer to #249-251.
  - docs/README.md — Client tooling table grows 6 rows (DriverClis parent
    + 5 per-CLI). Also corrects the Client.CLI.md row: it's otopcua-cli,
    not lmxopcua-cli (renamed in #208).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

dohertj2 merged commit 1507486b45 into v2

2026-04-21 08:57:26 -04:00

dohertj2 referenced this issue from a commit

2026-04-21 08:57:27 -04:00

Merge pull request 'Task #252 — docs/ index + parent doc for the driver CLI suite' (#206) from task-252-driver-cli-index into v2

dohertj2 referenced this issue from a commit

2026-04-30 08:21:26 -04:00

Doc refresh (task #206) — Client.CLI + Client.UI brand flip + new top-level docs/README.md index. Client.CLI.md: replaced stale LmxOpcUa-OPC UA-server references with OtOpcUa throughout the overview + sample output + applicationUri examples (opc.tcp://localhost:4840/OtOpcUa, urn:localhost:OtOpcUa:instanceN); confirmed against src/ZB.MOM.WW.OtOpcUa.Server/Program.cs:69-71 which sets the live endpoint url + application uri to those exact values. Added a driver-agnostic note in the overview — the CLI is reachable against every shipped driver surface because the OPC UA endpoint abstracts them all. Kept the `lmxopcua-cli` executable name + the `{LocalAppData}/LmxOpcUaClient/pki/` PKI folder name AS-IS because those are real filesystem-level residuals the code still uses (Program.cs SetExecutableName + OpcUaClientService.cs:428) — flipping them requires migration shims so existing dev boxes don't lose their trusted-cert store; added explicit doc text explaining the residual + why it persists so future readers aren't confused. Fixed the sample connect-output "Server: LmxOpcUa" to "Server: OtOpcUa Server" matching the live ApplicationName in OpcUaServerOptions.cs:39. Client.UI.md: replaced the 4 LmxOpcUa references — overview one-liner, status-bar mock (now reads "OtOpcUa Server" matching the server's reported ApplicationName), endpoint-url example, settings persistence path. Same residual-explanation note added under the LmxOpcUaClient/settings.json path pointing at the Client.Shared session-factory literal at OpcUaClientService.cs:428. docs/README.md is new — a top-level index distinguishing the two documentation tiers (current reference at docs/*.md vs implementation history + design notes at docs/v2/*.md). Every current-reference doc gets a one-line role description in a section table (Architecture + data-path / Drivers / Operational / Client tooling / Requirements) so a new reader picking up the repo finds their way in without having to grep file names. Cross-link calls out that load-bearing references from top-level docs (plan.md decisions, admin-ui.md, acl-design.md, config-db-schema.md, driver-specs.md, dev-environment.md, test-data-sources.md) live under v2/. Notes up front that the project was renamed LmxOpcUa → OtOpcUa and that any remaining LmxOpcUa-string in paths is a deliberate residual with a migration follow-up, so readers don't chase phantom bugs. Four parallel doc-refresh agents currently working on the rest of docs/*.md (task #202 core architecture, #203 driver docs split, #204 operational, #205 requirements) — those commits will land on separate worktree branches + get folded in together once complete; this index already lists the docs they'll produce (drivers/README.md, drivers/Galaxy.md, drivers/Galaxy-Repository.md) so the final merge just has the content showing up where the index already points.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: dohertj2/lmxopcua#206