docs: rewrite README quickstart and move dev docs to CONTRIBUTING - #13
Merged
TheGreatAxios merged 3 commits intoSep 27, 2026
Conversation
TheGreatAxios
commented
Sep 25, 2026
TheGreatAxios
left a comment
Contributor
Author
There was a problem hiding this comment.
Review
Independent review of the stack found: bad base64 replies escaped as a raw DOMException or silently truncated vectors; non-integer indices were accepted; duplicate-index and non-JSON-200 coverage was lost; the live suite failed instead of skipping when the model was absent. All fixed in this stack (strict base64 decode, number.integer index, restored harness tests, model-aware skip).
Remaining notes: peer range >=0.4.0 follows sibling convention. Each commit typechecks, tests, and builds standalone.
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 25, 2026 13:50
fedb4f8 to
f21725a
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 25, 2026 13:58
f21725a to
4153dad
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 25, 2026 14:08
4153dad to
09fe960
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
2 times, most recently
from
September 25, 2026 17:05
edc2c32 to
1a7678b
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 25, 2026 17:32
42314c6 to
a327550
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
2 times, most recently
from
September 25, 2026 22:44
eff4b13 to
ee7b566
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 25, 2026 23:48
ee7b566 to
dd310e6
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 25, 2026 23:49
dd310e6 to
f64731b
Compare
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 26, 2026 00:37
f64731b to
233b4d5
Compare
The quickstart embeds two strings with a literal config and prints the count and width; no env loader, spread, or manual deps. Errors document EmbeddingRequestError, the internal transport section is gone, the @intx/inference paragraph appears once under Using with Interchange, and Versioning/Development move to CONTRIBUTING.md. Also closes CL-9093, CL-9090, CL-9098.
TheGreatAxios
force-pushed
the
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
branch
from
September 26, 2026 01:29
233b4d5 to
605e64e
Compare
TheGreatAxios
added this pull request to stack #15
September 26, 2026 01:58
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
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.
Summary
embedTexts(["a", "b"], config)printing count and width, install line with the@intxpeers, options table,EmbeddingRequestErrorunder Errors, an Upgrading from 0.1 section, and a single Using with Interchange section.Verification
2 768againstnomic-embed-text; prettier, lint, typecheck, build andbun run test(16 pass); CI passes.Closes CL-9089
Closes CL-9093
Closes CL-9090
Closes CL-9098