Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 3.56 KB

File metadata and controls

59 lines (45 loc) · 3.56 KB

KNet documentation map

KNet documentation separates current capability truth from dated design and delivery records. This distinction is intentional: implementation presence, automated evidence, and release support are different states.

Current sources of truth

Use these documents when deciding what the repository currently owns or supports:

  1. README.md — public product scope, maturity summary, setup, limitations, and verification entry points.
  2. module_responsibility_index.md and each module's MODULE.md — current ownership and dependency direction.
  3. adr/ — accepted architectural decisions and invariants.
  4. Focused qualification documents — protocol-specific implemented evidence and remaining promotion gates: http2_target_and_implementation_plan.md, grpc_qualification.md, websocket_qualification.md, graphql_websocket_qualification.md, and sse_qualification.md.
  5. The executable RuntimeCapabilityCatalog in products/desktop/src/jvmMain/kotlin/com/devuloopers/knet/products/desktop/di/inspection/InspectionBindings.kt — final product maturity (SUPPORTED, EXPERIMENTAL, or UNAVAILABLE).

When prose and the runtime catalog disagree, use the more conservative status and correct the prose. A capability is not release-supported merely because source code or a simulator build exists.

Companion status

Android and iOS implementations now exist for pairing, protected state, discovery, certificate setup/readiness, and local VPN/packet-tunnel integration. Android Companion and Android VPN inspection have passed a manual physical-device end-to-end smoke test and are therefore EXPERIMENTAL, not unavailable. Automated gates also compile/test shared and platform boundaries, assemble the Android debug app, and link the iOS Simulator framework. The iOS/iPadOS app is EXPERIMENTAL; physical iOS packet-tunnel inspection remains UNAVAILABLE until a properly entitled build is qualified on devices.

See companion_connectivity_kmp.md and companion_certificate_readiness.md for current implementation boundaries.

Historical and planning records

The following files preserve useful reasoning and chronological delivery evidence, but dated status statements inside them are not current capability claims:

Do not copy a historical future, unavailable, or completed statement into public release notes without checking the current module contracts, runtime catalog, and focused gate.

Architecture images