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

Merged
dohertj2 merged 1 commits from task-252-driver-cli-index into v2 2026-04-21 08:57:26 -04:00
Owner

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
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
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: dohertj2/lmxopcua#206