Skip to content

docs(#463): I/O adapters user guide and CHANGELOG#501

Merged
justinjoy merged 2 commits intomainfrom
feat/463-io-adapters-docs
Apr 14, 2026
Merged

docs(#463): I/O adapters user guide and CHANGELOG#501
justinjoy merged 2 commits intomainfrom
feat/463-io-adapters-docs

Conversation

@justinjoy
Copy link
Copy Markdown
Collaborator

Summary

  • Add docs/io-adapters.md covering adapter interface, context accessors, registration API, Path A library embedding, Path B CLI plugin contract, ownership rules, ABI versioning policy, and thread-safety notes
  • Path A code block is verbatim-identical to examples/path_a_pcap_skeleton/main.c (verified programmatically)
  • Path B section marked as "Planned (Optional CLI plugin loader (gated, Path B) #461)" with explicit caveat that symbols are not yet defined
  • Add CHANGELOG entries under [Unreleased] for the full I/O adapter feature set

Test plan

  • Verbatim match: docs code block == examples/path_a_pcap_skeleton/main.c (Python diff)
  • Technical accuracy: all accessor signatures, vtable fields, return values verified against wirelog/io/io_adapter.h
  • CHANGELOG entries cross-referenced with actual issue numbers
  • Markdown formatting: headers, tables, code fences, relative links validated

Closes #463

Add docs/io-adapters.md covering adapter interface, context accessors,
registration API, Path A library embedding (verbatim #462 example),
Path B CLI plugin contract (planned #461), ownership rules, ABI
versioning policy, and thread-safety notes.
Document new features under [Unreleased]: I/O adapter framework,
built-in CSV adapter, wl_easy facade, string operations, Path A
example, binary size gate, user guide, retraction support, and
delta query examples.
@justinjoy justinjoy merged commit dabde0a into main Apr 14, 2026
7 checks passed
@justinjoy justinjoy deleted the feat/463-io-adapters-docs branch April 14, 2026 08:07
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.

docs/io-adapters.md user guide + CHANGELOG entry

1 participant