Files

Siavash Sameni ed8a7ae5aa docs: protocol audit 2026-05-25, update architecture + Obsidian vault

Audit:
- docs/AUDIT-2026-05-25.md: full protocol audit covering 8 findings
  (4 critical, 2 high, 5 medium, 4 low) with code references and fix
  effort estimates
- vault/Audit/Tasks.md: Obsidian Tasks plugin file tracking all audit
  items with priorities, due dates, and per-step checklists

Architecture docs updated for Wire format v2 and Wave 5/6 features:
- ARCHITECTURE.md: adds wzp-video to dependency graph and project
  structure; wire format updated to v2 (16B header, 5B MiniHeader);
  relay concurrency section corrected (DashMap+RwLock is current, not
  a future optimization); test count 571→702; Android note
- PROGRESS.md: Wave 5 and Wave 6 sections appended; test count 372→702;
  current status and open blockers as of 2026-05-25
- ROAD-TO-VIDEO.md: implementation status table inserted (✅/🟡/🔴/🔲
  per phase); 6-step critical path to first video call
- WZP-SPEC.md: MediaHeader updated to v2 (16B byte-aligned); MiniHeader
  updated to 5B with seq_delta; codec IDs 9-12 added (H.264/H.265/AV1);
  version negotiation section added

Obsidian vault (vault/):
- 114 files across Architecture/, PRDs/, Reports/, Android/,
  Reference/, Audit/ with YAML frontmatter
- 00 - Home.md index note with wiki links
- .obsidian/app.json config

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-05-25 06:00:17 +04:00

2.5 KiB

Raw Permalink Blame History

tags, type, status

T1.4.1 — Add rustdoc on `MiniHeaderV2` / `MiniFrameContextV2` public items

Status: Approved Agent: Kimi Code CLI Started: 2026-05-11T07:26Z Completed: 2026-05-11T07:27Z Commit: see git log PRD: ../PRD-wire-format-v2.md

What I changed

crates/wzp-proto/src/packet.rs:641-645 — added /// doc comments to all 3 fields of MiniHeaderV2 (seq_delta, timestamp_delta_ms, payload_len)
crates/wzp-proto/src/packet.rs:648 — added /// doc on WIRE_SIZE
crates/wzp-proto/src/packet.rs:650 — added /// doc on write_to
crates/wzp-proto/src/packet.rs:656 — added /// doc on read_from
crates/wzp-proto/src/packet.rs:705 — added /// doc on MiniFrameContextV2::update
crates/wzp-proto/src/packet.rs:709 — added /// doc on MiniFrameContextV2::expand

Why these choices

Follow-up from T1.4 review: coding standard #9 requires /// on all public items. Added concise one-line docs matching the task spec examples.

Deviations from the task spec

None.

Verification output

$ cargo doc -p wzp-proto --no-deps 2>&1 | grep -i "missing" || echo "no missing-doc warnings"
no missing-doc warnings

$ cargo clippy -p wzp-proto --all-targets -- -D warnings -W missing_docs 2>&1 | grep -E "packet.rs:6[4-9][0-9]|packet.rs:7[0-1][0-9]" | head -10
# (no output — no missing-docs in MiniHeaderV2 / MiniFrameContextV2 region)

$ cargo build -p wzp-proto
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.24s

$ cargo test -p wzp-proto --no-fail-fast
running 112 tests
test result: ok. 112 passed; 0 failed; ...

$ cargo fmt --all -- --check
# (clean)

Test summary

Tests added: 0
Tests modified: 0
cargo clippy -p wzp-proto --all-targets -- -D warnings: pass
cargo fmt --all -- --check: pass

Risks / follow-ups

None.

Reviewer checklist (filled in by reviewer)

Code matches PRD intent
Verification output is real (re-run if suspicious) — re-ran the region-scoped clippy grep; zero hits.
No backward-incompat surprises
Tests cover the new behavior
Approved

Reviewer notes (2026-05-11)

Approved. All 3 fields + 3 MiniHeaderV2 members + 2 MiniFrameContextV2 methods carry /// docs. Both Verify commands run. Closes the rustdoc trilogy (T1.1.1 / T1.2.1 / T1.4.1) — every public item added by Wave 1 v2 wire-format tasks now has documentation.

2.5 KiB Raw Permalink Blame History

T1.4.1 — Add rustdoc on MiniHeaderV2 / MiniFrameContextV2 public items