docs: first-principles refresh — encoding reality, architecture, overhead verdict, hardening backlog#14
Merged
Merged
Conversation
…tecture, overhead verdict, hardening backlog) Across README/RATIONALE/PERFORMANCE/NEURO_CYBERNETIC_PROTOCOL/INTEGRATING/VERSIONING/SECURITY/RESILIENCE/ROADMAP/proto+gen+ncp-core+ncp-zenoh+e2e READMEs: correct the protobuf overstatement (protobuf = schema/IDL + conformance; runtime wire is JSON + binary BulkBlock; prost bindings uncompiled), document the generic-hub architecture (Engram/Paper2Brain = command-center; crebain = standalone and/or NCP; prisoma = observer), add the measured overhead verdict (full tick ~1us, 0.003-0.1% of budget; Zenoh chosen for features not latency; the payload.to_vec()->SHM zero-copy win), and reference the new examples/benches. Adds KNOWN_LIMITATIONS.md: 35 audited findings (3 high) as proposals — NONE applied (no NCP code/protocol changed).
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
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
Comprehensive, accuracy-correcting documentation pass (docs only — no protocol/library/code changes). Grounded in this session's measurements + a 20-lens review + a 35-finding audit.
Corrections
serde_json) on Sensor/Command/RPC + a binaryBulkBlockfor bulk observations; the prostgen/rustbindings are generated artifacts, not compiled into the SDK. (Fixes the prior "JSON/protobuf is the wire" overstatement across README/RATIONALE/proto/gen.)Additions
ncp-zenohpayload.to_vec()→ SHM zero-copy).New file
KNOWN_LIMITATIONS.md— 35 audited findings (3 high:bulk.rsdecode OOM-DoS; fail-OPEN unbounded/+Infttl_mswatchdog; empty-position geofence bypass), each markedsafevswire-breaking. Proposals only — none applied.