docs: refresh stale command summaries and gaps#476
Conversation
Bring the high-level documentation back in line with the current CLI: - overview.md / command_spec.md Status: add the command families the summaries had fallen behind on (simulate, compare, capture-info, sequence replay, datasets download, j1939 map, the full UDS active workflow set, the doip group, xcp info/dump, plot, re corpus, skills, and the fuzz commands); describe the tui as the full-screen Textual dashboard instead of the retired text-mode shell. - overview.md / command_spec.md Current Gaps: drop the fuzzing bullet that listed already-implemented payload/replay/arbitration-id fuzzing as not yet exposed; keep the genuinely pending items. - feature-matrix.md: note the dedicated doip command group, xcp info/dump, and fuzz identify. - README.md: list fuzz guided in the full command catalog. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QzKmmaP3LvVgWWRPrLWpUv
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 522847b613
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| * live and deterministic transport workflows for `capture`, `send`, and `generate` | ||
| * file-backed `filter` and `stats` over candump capture logs | ||
| * live and deterministic transport workflows for `capture`, `send`, `generate`, and `simulate` |
There was a problem hiding this comment.
This documentation refresh changes high-level command summaries in four docs, so it is more than the typo/nav exceptions, but the diff does not include CHANGELOG.md. AGENTS.md requires every "significant documentation update" to have a [Unreleased] changelog entry, so the release notes will miss this docs-currency fix unless it is added in this commit.
Useful? React with 👍 / 👎.
| * file-backed `filter`, `stats`, `decode`, `j1939 decode`, and `replay` using candump logs | ||
| * DBC-backed `decode`, `encode`, and `dbc inspect`, including provider-ref resolution and `dbc_source` provenance in structured output | ||
| * `python-can`-backed live transport workflows plus deterministic scaffold transport for `capture`, `send`, `generate`, and `simulate` | ||
| * file-backed `filter`, `stats`, `compare`, `capture-info`, `decode`, `j1939 decode`, `replay`, and `sequence replay` using candump logs |
There was a problem hiding this comment.
Adding sequence replay to the bullet that says these commands use candump logs is misleading: the parser and design spec define sequence replay --file as a YAML/JSON sequence file of DBC-encoded frames (src/canarchy/cli.py lines 688-691), not a candump capture. Operators following this summary with a capture log will get a sequence load/schema error, so this should be a separate YAML/JSON sequence-file workflow or excluded from the candump-log list.
Useful? React with 👍 / 👎.
- overview.md: move `sequence replay` out of the candump-log workflow bullet; it consumes a YAML/JSON sequence of DBC-encoded frames, not a capture log (PR #476 review, P2). - CHANGELOG.md: add the required `[Unreleased]` Documentation entry for this docs-currency refresh (PR #476 review, P1). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QzKmmaP3LvVgWWRPrLWpUv
2 participants
Summary
Routine documentation review: the high-level summary sections in a few docs had drifted behind the actual command surface and per-command reference sections in the same files.
Changes
docs/overview.md/docs/command_spec.md(Status / Current Capabilities): added command families the summaries had fallen behind on —simulate,compare,capture-info,sequence replay,datasets download,j1939 map, the full UDS active workflow set (subservices,ecu-reset,tester-present,security-seed,dump-dids,read-memory,auto), thedoipcommand group,xcp info/xcp dump,plot,re corpus, theskillsprovider workflows, and thefuzzcommands.tuidescription from the retired "initial text-mode shell" to the current full-screen Textual dashboard (already rewritten in Rewrite TUI as full-screen Textual app with live streaming #474).--targetsallowlist, norate_cap,KILL_SWITCH_TRIGGEREDstill a tracked follow-up in code).docs/feature-matrix.md: noted the dedicateddoipcommand group,xcp info/dump, andfuzz identifyin the narrative section.README.md: addedfuzz guidedto the "full command catalog" (it was the one command missing from that list).No command-surface or behavior changes — documentation only.
Test plan
uv run mkdocs build --strict(docs site builds clean with the updated content)canarchy <cmd> --helpoutput andsrc/canarchy/cli.pyuv run python -m unittest discover -s tests -v(not run — no code changed)uv run ruff check(not run — no code changed)Documentation
CHANGELOG.mdupdated under[Unreleased](docs-accuracy fix, not a user-facing change)docs/command_spec.mdupdated (summary sections only; per-command contract already accurate)docs/event-schema.mdupdated (no schema change)docs/design/spec updated (no design change)docs/tests/spec updated (no test spec change)AGENTS.md/docs/agents.mdupdated (already accurate; verified during review)mkdocs.ymlnav updated (no new pages)Safety
--ack-active(not applicable — no code changes)SECURITY.mdreviewed against the new behaviour (not applicable — no behavior change)Generated by Claude Code