docs: align existing docs/ pages with the ASAPv1 wire format#66
Merged
Conversation
GordonYuanyc
force-pushed
the
feat/asapv1-wire-envelope
branch
from
July 19, 2026 03:28
166e23a to
130e4e1
Compare
…ss-language framing) Rewrite message_pack_format.md to describe the shared envelope.rs framing, per-sketch <sketch>/wire.rs serialization, and HashProfile-derived metadata, and to mark portable/native as deprecated. Point every wire-touching doc at docs/asapv1_wire_format.md as the single source of truth. Note the serialize helpers are bounded on wire-eligible configs (HLL: HllWireVariant + HashProfile; CMS: CmsWireCounter/CmsWireMode + HashProfile). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
GordonYuanyc
force-pushed
the
docs/asapv1-doc-alignment
branch
from
July 19, 2026 04:27
1e8de0b to
4d34d46
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Aligns the pre-existing
docs/pages with the ASAPv1 wire format introduced in #65 — the pages that described the old serialization framing (or had it backwards).This is intentionally split out of #65 so that PR stays focused on the wire format itself (implementation + the
asapv1_wire_format.mdspec + golden vectors), and the "touch a bunch of unrelated existing doc pages" churn is reviewed separately.Changes
docs/message_pack_format.md— full rewrite. It was inverted: it calledportable/"the cross-language wire format shared with Go" andnative/"internal, Go never reads it." That is backwards now — the ASAPv1 (native/ per-sketchwire.rs) path is what Go mirrors, andportable/is deprecated. Now describes the sharedenvelope.rsframing, per-sketchwire.rs,HashProfile-derived metadata, and points toasapv1_wire_format.mdas the spec.docs/library_map.md—<sketch>.rs+<sketch>/wire.rssplit;message_pack_formatdescription (addenvelope.rs, markportable/nativedeprecated).docs/api/api_countmin.md—serialize_to_bytesonly for wire-eligible configs (i64/f64, FastPath/RegularPath,H: HashProfile); default i32 must be converted; kind0x02 0x00; rows/cols are metadata.docs/api/api_hyperloglog.md— serialize methods bounded onHllWireVariant+HashProfile, produce the ASAPv1 envelope.docs/index.md,docs/project_overview.md,docs/features.md— corrected the "portable variants shared with sketchlib-go" framing; link the spec.Dependency
Stacked on #65 (base =
feat/asapv1-wire-envelope) — these docs describe code that #65 introduces. Merge after #65. (docs/asapv1_wire_format.mditself — the design spec — stays in #65.)🤖 Generated with Claude Code