wifi-densepose/docs
ruv f51a045215 docs(adr-118): user-guide.md BFLD subsection (345/345 GREEN)
Iter 52. PR-readiness pivot iter #3. Closes pre-merge checklist item #6
(user-guide.md update for new setup steps / CLI flags / integrations).
Adds a BFLD subsection inside the existing HA chapter so operators
already reading about HA-DISCO discover BFLD as the natural next layer.

Notes on iter context:
- Local branch was hard-reset earlier in the session (working tree
  showed only iters 1-3 state); remote origin/feat/adr-118-bfld-impl
  retained the full chain plus a sibling agent's ADR-124 commit
  (12586d31a, RUVIEW-POLICY layer + Q4 cache + multi-modal vision).
  Recovered local via git reset --hard origin/feat/adr-118-bfld-impl
  before this iter. No work lost.
- User redirected to "finish BFLD first" mid-iter, so the ADR-124
  pivot (scaffolding tools/ruview-mcp BFLD tool handlers) was stopped.
  ADR-124 work remains in the sibling agent's lane on this branch.

Added (in docs/user-guide.md):
- New ### BFLD — privacy-gated WiFi BFI sensing layer (ADR-118)
  subsection inside the "Home Assistant + Matter integration" chapter.
- Covers:
    * Three structural invariants (I1/I2/I3)
    * Minimal + worker-thread runnable example commands
    * Production publish lifecycle code snippet
      (publish_availability_online → publish_discovery →
       BfldPipelineHandle::spawn → handle.send)
    * 4 HA entities per node + class-2-only identity_risk note
    * Three operator HA blueprints (presence-lighting, motion-hvac,
      identity-risk-anomaly) with import path
    * Privacy class deployment matrix table (Raw / Derived / Anonymous /
      Restricted) with use cases
    * MQTT topic tree with all 7 documented topics
    * `mqtt` feature gate + rumqttc::connect_with_lwt LWT pre-config note
    * Pointers to crate README + research dossier + ADR-118 chain

Added (in v2/crates/wifi-densepose-bfld/tests/user_guide_section.rs):
- 8 named tests via include_str! validating the user-guide section:
    user_guide_documents_bfld_section_in_ha_chapter
    user_guide_bfld_section_names_three_structural_invariants
    user_guide_bfld_section_shows_both_runnable_examples
    user_guide_bfld_section_documents_publish_lifecycle (4 symbol checks)
    user_guide_bfld_section_documents_four_privacy_classes
    user_guide_bfld_section_lists_three_operator_blueprints
    user_guide_bfld_section_documents_mqtt_topic_tree (3 topic checks)
    user_guide_bfld_section_points_at_companion_artifacts

ADR-124 status (iter step 0 sibling check):
- docs/adr/ADR-124-rvagent-mcp-ruvector-npm-integration.md present.
  Sibling agent landed a follow-on commit 12586d31a touching
  ADR-124 ("RUVIEW-POLICY layer + Q4 cache resolution + multi-modal
  vision"). Scope continues to be orthogonal to BFLD core.

ACs progressed:
- Pre-merge checklist item #6 (CLAUDE.md) — user-guide.md updated.
  Operators encountering wifi-densepose for the first time and
  reading the canonical user guide now see the BFLD layer documented
  alongside HA + Matter, not as a separate document they have to
  hunt for.

Test config:
- cargo test --no-default-features → 101 passed (user_guide_section cfg-out)
- cargo test                       → 345 passed (337 + 8)

Out of scope (next iter target):
- Pre-merge checklist remaining: witness bundle regeneration (#8).
  External-resource-gated work (KIT BFId, Pi5/Nexmon) still skipped.

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-05-24 20:16:41 -04:00
..
adr docs(adr-124): RUVIEW-POLICY layer + Q4 cache resolution + multi-modal vision 2026-05-24 20:11:24 -04:00
archtocode-visual-overview docs: add visual architecture overview images (#208) 2026-05-17 18:18:07 -04:00
benchmarks docs(bench): append v0.0.2 section to person-count benchmark log 2026-05-21 19:47:55 -04:00
ddd docs: rvCSI edge RF sensing platform — PRD, ADR-095, DDD domain model 2026-05-12 23:15:10 +00:00
edge-modules chore(repo): rename rust-port/wifi-densepose-rs → v2/ (flatten to one level) (#427) 2026-04-25 21:28:13 -04:00
huggingface fix(train): wire wifi-densepose-signal into the pipeline; correct MODEL_CARD env-sensor claim (#536) 2026-05-11 23:40:55 -04:00
integrations feat(adr-117): pip wifi-densepose modernization (PIP-PHOENIX) + ruview sibling release (#786) 2026-05-24 13:00:38 -04:00
prd docs: rvCSI edge RF sensing platform — PRD, ADR-095, DDD domain model 2026-05-12 23:15:10 +00:00
qe-reports chore(repo): move v1/ → archive/v1/ + add archive/README.md (#430) 2026-04-25 23:07:52 -04:00
releases ADR-115: Home Assistant + Matter integration (#778) 2026-05-23 16:13:28 -04:00
research docs+plugins: rvAgent + RVF agentic-flow integration exploration 2026-05-24 17:33:12 -04:00
tutorials docs(tutorials): Pi 5 + Hailo cluster rvcsi tutorial (#546) 2026-05-17 17:41:39 -04:00
ADR-110-BRANCH-STATE.md ADR-110: ESP32-C6 firmware extension (#764) 2026-05-23 15:34:48 -04:00
ADR-110-REVIEW-GUIDE.md ADR-110: ESP32-C6 firmware extension (#764) 2026-05-23 15:34:48 -04:00
TROUBLESHOOTING.md fix(docker): UDP relay for multi-source ESP32 on Docker Desktop Windows (#502) 2026-05-17 18:01:44 -04:00
WITNESS-LOG-028.md chore(repo): move v1/ → archive/v1/ + add archive/README.md (#430) 2026-04-25 23:07:52 -04:00
WITNESS-LOG-110.md ADR-110: ESP32-C6 firmware extension (#764) 2026-05-23 15:34:48 -04:00
build-guide.md chore(repo): move v1/ → archive/v1/ + add archive/README.md (#430) 2026-04-25 23:07:52 -04:00
readme-details.md docs(readme): split details to docs/readme-details.md and reorganize 2026-04-29 19:34:24 -04:00
security-audit-wasm-edge-vendor.md chore(repo): rename rust-port/wifi-densepose-rs → v2/ (flatten to one level) (#427) 2026-04-25 21:28:13 -04:00
user-guide.md docs(adr-118): user-guide.md BFLD subsection (345/345 GREEN) 2026-05-24 20:16:41 -04:00
wifi-mat-user-guide.md chore(repo): rename rust-port/wifi-densepose-rs → v2/ (flatten to one level) (#427) 2026-04-25 21:28:13 -04:00