docs: sync README/ARCHITECTURE with 0.4.0 codebase#5
Merged
Conversation
The docs still described the pre-0.4.0 layout (a monolithic commands/ai.rs, flat lib/, no modbus/ barrel, no terminal sub-components) and were missing the batch 5-16 features. Sync them with the actual source tree: README (EN + CN): - Rewrite the project-structure tree: ai/ subdir + ai/types split, log.rs, updater.rs, ipc/window contract tests, benches/hot_paths.rs, terminal sub-components (Modbus/Parser/Waveform + their split-outs), app-shell/, the 15-module lib/modbus/ barrel, and the lib/ domain modules added since (waveform-viewport, waveform-render, protocol-engine, bbrec, macro-control-flow, write-chunking, export-filters, ai-models, ai-stream, serial-rx-queue, connection-presets, session-persistence, locales/), the per-domain types/ split, and the .github/.c8rc.json gates. - Document the new features: HEX+ASCII display mode, large-write chunking, .bbrec record/replay, conditional macros (wait/if/goto), live status metrics (frames/s, buffer %, dropped), SSE AI streaming, auto-update check, versioned persistence, time-range/direction export filter, F12 IPC-bypass export. - Expand the Tech Stack table (updater, criterion, c8/tarpaulin, madge) and the Available Scripts table (lint, test, coverage:lib, bench:frontend:write, cycles). - Refresh test counts (576 frontend + 71 Rust) and the architecture notes (shallowRef store, O(1) ring buffer, TX single-serialization). ARCHITECTURE.md: - Refresh the verification-strategy table (576/71 tests, 88/88/85 c8 thresholds, per-file lib/ gate, release.yml) and the T2.2 coverage numbers to match the current suite. docs/high-baud-measurement.md: - Add the F2/F3/F5 config matrix and the reproducible socat/PTY procedure referenced by ARCHITECTURE.md (T2.4) and CHANGELOG.md but never created.
Remove docs/high-baud-measurement.md and every reference to it. The F2/F3 config matrix and socat/PTY procedure it described are preserved inline in the ARCHITECTURE.md manual-verification checklist (T2.4 entry now points there), so no guidance is lost — only the dangling path and the extra file. - README (EN/CN): drop the docs/ line from the project-structure tree. - ARCHITECTURE.md: inline the F2/F3 + socat note, drop the dead link. - CHANGELOG.md: reword the two T2.4 entries that referenced the file (one falsely claimed it was "added" — it was never committed).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs still described the pre-0.4.0 layout (a monolithic
commands/ai.rs, flatlib/, nomodbus/barrel, no terminal sub-components) and were missing every feature shipped in CHANGELOG batches 5–16. This PR syncs the documentation with the actual 0.4.0 source tree.Changes
README.md+README.zh-CN.md(mirrored)commands/ai/subdir (+ai/typessplit),log.rs,updater.rs,ipc_contracts.rs,window_contracts.rs,benches/hot_paths.rsterminal/sub-components (ModbusPanel+Header/AddForm/RegisterRow,ParserPanel+ConfigBar/StatsBar/FrameDetail,WaveformPanel+Legend),app-shell/lib/modbus/barrel + the domain modules added since (waveform-viewport,waveform-render,protocol-engine,bbrec,macro-control-flow,write-chunking,export-filters,ai-models,ai-stream,serial-rx-queue,connection-presets,session-persistence,locales/)types/split, and the.github/workflows/+.c8rc.jsongates.bbrecrecord/replay, conditional macros (wait/if/goto), live status metrics (frames/s, buffer %, dropped), SSE AI streaming (F14), auto-update check, versioned persistence migration chain, time-range/direction export filter (F-e), F12 IPC-bypass exportlint,test,coverage:lib,bench:frontend:write,cycles)ARCHITECTURE.mdlib/gate,release.yml)docs/high-baud-measurement.md(new)socat/PTY procedure referenced byARCHITECTURE.md(T2.4) andCHANGELOG.md— referenced but never created until now.Verification
src/).🤖 Generated with ZCode