Skip to main content

Implementation Notes — neokapi Framework

Implementation notes contain tactical details for the neokapi framework (Apache-2.0): SQL schemas, wire protocols, algorithm pseudocode, Go interface signatures, and other reference material. They exist alongside the Architecture Decisions, which describe the design choices; notes describe the implementation.

NoteParent ADContent
Implementing FormatsAD-005Step-by-step guide for new format readers/writers
Skeleton StoreAD-005SkeletonStore binary format, streaming HTML support, sub-skeleton
Content-Fidelity SurfacingAD-031Surfacing non-translatable context: the inverted toggle, channels, parity force-off
OMML Math ConversionAD-032core/math Exp AST, OMML reader, nor-splice algorithm, coverage ledger
Flow Steps FormatAD-006YAML step list, fan-out, script steps
Session-Scoped Tool AuthoringAD-006Guide for writing tools against BlockStore
Plugin ModelAD-007In-process registry contract for plugin binaries
Plugin protocol v1AD-007The versioned plugin contract: manifest rules, the three transports, the Mode-C gRPC surface and wire format, and the conformance suite
Kapi Project FileAD-008kapi.yaml recipe schema and examples
Content Memory Matching AlgorithmAD-009Tiered matching, TMX mapping
Terminology Data ModelAD-010Go structs, Terminology interface
MCP Tools ReferenceAD-013Tool specs, input/output schemas
CLI ConventionsAD-013Input/output/exit-code/project contracts, per-command surface table
Tool & Data Model RationaleAD-006 · AD-002Why stand-off overlays + annotations, a typed consumes/produces IO contract, a uniform unit iterator, and typed source/sink bindings
Markdown in the UIAD-006 · AD-005Which metadata fields carry markdown, and the shared Markdown typeset primitive that renders them
Content-Model Parity Over the Sync WireAD-034 · AD-002The lossless model↔proto↔store round-trip invariant, what must round-trip, and the extend-without-breaking checklist gated by the kitchen-sink conformance test