Clarify VTX-as-format framing and add SDK API wiki page
- Replace 'recording' with 'writing'/'diffing' where it could be read
as game-capture rather than SDK-level persistence (Home, FAQ,
SDK Architecture, File Format, Performance, Runtime Contracts)
- Rename 'Write/Read a replay' section headings to 'Write/Read a VTX
file' in Getting Started
- Add SDK-API.md: thin overview of entry points plus recipes for
common integration tasks (open/read, range reads, copy-out, cache
tuning, property resolution, metadata, write, populate Frame,
IFrameDataSource, diff, error policies). Links to docs/SDK_API.md
for the full reference
- Add SDK API page to sidebar and Home navigation
Accuracy pass: drop macOS, fix perf overclaims, unify writer terminology
- Remove macOS from supported platforms; CI covers Windows + Linux only
- Replace 'Competitive with peer tooling' with a concrete throughput number
- Qualify 'sub-millisecond scrubbing' as warm-cache; cold seeks are tens
of milliseconds while the chunk decompresses. Applied consistently
across Concepts, File Format, FAQ, Use Cases
- Drop 'below UX perceptibility' claim on 1 s preview (1 s is not below
perceptibility thresholds). Replace with 'fast feedback for preview UI'
- Use 'writer' consistently across SDK Architecture and Tools; retire
leftover 'producer' terminology
- Remove orphaned glossary entries (VTX Bind, VTX Access, VTX Insider)
that didn't appear anywhere else in the wiki
Review pass: accuracy, rigor, and honesty
- Correct O(1) claims to O(log n) + chunk decompress
- Clarify frames are stored as complete per-frame blobs, not deltas
- Add Runtime Contracts page: thread safety, ownership/lifetime,
error model (reader status-object, writer exceptions, deserialiser
compile-time policies), memory model, platform tiers, hard limits
- Add Stability and Versioning page: API SemVer policy, on-disk format
versioning, schema evolution rules, deprecation process
- Qualify 1.70 ns isolated EntityView benchmark as a micro-benchmark
ceiling; lead with the realistic ~80 ns number
- Document cache-window defaults and the 59% mis-sizing cliff
- Fix writer example to use CreateFlatBuffersWriterFacade /
CreateProtobuffWriterFacade (the functions that actually exist)
- Fix reader example to use ReaderContext as documented in the header
- Note endianness (little-endian), chunk defaults, and no-mmap design
- Drop unsupported 'engine reflection auto-generates schemas' claim;
note it as an internal tooling pattern, not an OSS feature
- Tone down Home and Use-Cases; add 'When VTX is not the right tool'
- Expand FAQ with thread safety, frame-pointer lifetime, error model,
versioning, memory footprint, hard limits
Formatting cleanup: drop em dashes, tighten phrasing
Flesh out VTX wiki
Home, Getting Started, Concepts, File Format, SDK Architecture,
Performance, Tools, Use Cases, FAQ, Glossary, plus sidebar/footer.