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