Skip to content

docs: rewrite README quickstart and move dev docs to CONTRIBUTING - #13

Merged
TheGreatAxios merged 3 commits into
cl-9069-embedding-add-eslint-config-and-lint-scriptfrom
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print
Sep 27, 2026
Merged

TheGreatAxios merged 3 commits into
cl-9069-embedding-add-eslint-config-and-lint-scriptfrom
cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Stacked on build: add eslint config and lint script #12.
  • README rewritten for first-time readers: literal-config quickstart with embedTexts(["a", "b"], config) printing count and width, install line with the @intx peers, options table, EmbeddingRequestError under Errors, an Upgrading from 0.1 section, and a single Using with Interchange section.
  • Versioning and Development move to CONTRIBUTING.md.

Verification

  • Quickstart prints 2 768 against nomic-embed-text; prettier, lint, typecheck, build and bun run test (16 pass); CI passes.

Closes CL-9089
Closes CL-9093
Closes CL-9090
Closes CL-9098

@TheGreatAxios TheGreatAxios left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from fedb4f8 to f21725a Compare September 25, 2026 13:50
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from f21725a to 4153dad Compare September 25, 2026 13:58
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from 4153dad to 09fe960 Compare September 25, 2026 14:08
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch 2 times, most recently from edc2c32 to 1a7678b Compare September 25, 2026 17:05
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from 42314c6 to a327550 Compare September 25, 2026 17:32
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch 2 times, most recently from eff4b13 to ee7b566 Compare September 25, 2026 22:44
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from ee7b566 to dd310e6 Compare September 25, 2026 23:48
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from dd310e6 to f64731b Compare September 25, 2026 23:49
@TheGreatAxios TheGreatAxios changed the title README: real quickstart, EmbeddingRequestError, CONTRIBUTING Rewrite the README quickstart and move development docs to CONTRIBUTING Sep 25, 2026
@TheGreatAxios
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from f64731b to 233b4d5 Compare September 26, 2026 00:37
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
TheGreatAxios force-pushed the cl-9089-embedding-rewrite-readme-quickstart-to-embed-and-print branch from 233b4d5 to 605e64e Compare September 26, 2026 01:29
@TheGreatAxios TheGreatAxios changed the title Rewrite the README quickstart and move development docs to CONTRIBUTING docs: rewrite README quickstart and move dev docs to CONTRIBUTING Sep 26, 2026
@TheGreatAxios
TheGreatAxios added this pull request to stack #15 September 26, 2026 01:58
@TheGreatAxios
TheGreatAxios merged commit 2287580 into main Sep 27, 2026
1 check passed
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