Skip to content

docs: Sync binary format docs with implementation#317

Merged
zharinov merged 1 commit intomasterfrom
docs/binary-format-sync
Jan 9, 2026
Merged

docs: Sync binary format docs with implementation#317
zharinov merged 1 commit intomasterfrom
docs/binary-format-sync

Conversation

@zharinov
Copy link
Member

@zharinov zharinov commented Jan 9, 2026

Summary

  • Fix TypeKind enum values in 04-types.md (Void=0, Node=1, String=2, etc.)
  • Update TypeId model to show primitives stored in TypeDefs
  • Add Trampoline opcode (0x8) to 06-transitions.md
  • Fix epsilon definition in 07-dump-format.md (Nav::Epsilon not Stay)
  • Simplify nav symbols table in 08-trace-format.md for trace output

Why

Documentation was out of sync with the actual implementation, causing confusion about TypeKind byte values, TypeId semantics, and the undocumented Trampoline instruction.

- Fix TypeKind enum values in 04-types.md (0=Void, 1=Node, etc.)
- Fix TypeId primitives model (all types stored in TypeDefs)
- Document Trampoline opcode (0x8) in 06-transitions.md
- Fix Epsilon definition in 07-dump-format.md
- Replace hand-written examples with real CLI output
- Use JSON-based example query that actually runs
- Update trace format examples with real plotnik trace output
@zharinov zharinov force-pushed the docs/binary-format-sync branch from 1751ffd to 1d1876d Compare January 9, 2026 01:06
@zharinov zharinov enabled auto-merge (squash) January 9, 2026 01:07
@zharinov zharinov merged commit 3aaf634 into master Jan 9, 2026
3 checks passed
@zharinov zharinov deleted the docs/binary-format-sync branch January 9, 2026 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant