docs: rewrite README around a concrete quickstart and an Errors section - #12
Merged
TheGreatAxios merged 5 commits intoSep 27, 2026
Conversation
TheGreatAxios
commented
Sep 25, 2026
TheGreatAxios
left a comment
TheGreatAxios
left a comment
Contributor
Author
There was a problem hiding this comment.
Self-review: diff checked against ticket outcomes; independent critique pass run, findings on README wording, registry example and CONTRIBUTING commands fixed. Typecheck, tests, prettier and build pass.
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 25, 2026 14:09
17a3ca0 to
0c49b77
Compare
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 25, 2026 14:16
0c49b77 to
8a293f4
Compare
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 25, 2026 17:32
8a293f4 to
6ec8d91
Compare
TheGreatAxios
changed the base branch from
cl-9155-reranking-replace-spread-built-request-options-with-explicit
to
cl-9321-reranking-export-requestdependencies-used-by-rerankoptions
September 25, 2026 17:32
TheGreatAxios
changed the title
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 25, 2026 22:53
6ec8d91 to
a353dbb
Compare
TheGreatAxios
changed the title
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 26, 2026 00:37
a353dbb to
e9baf2c
Compare
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 26, 2026 01:30
e9baf2c to
7881bd6
Compare
The quickstart ranks three literal documents against TEI and shows the output. How it works keeps the apiStyle table, custom registry usage and the index mapping. A new Errors section documents RerankRequestError. Runtime support and development commands move to CONTRIBUTING.md.
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 26, 2026 01:30
7881bd6 to
7254150
Compare
TheGreatAxios
changed the title
TheGreatAxios
added this pull request to stack #15
September 26, 2026 01:59
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 26, 2026 02:22
7254150 to
e52fb02
Compare
Unit tests stay colocated in src/ for the load-bearing logic: wire formats, retry and Retry-After parsing, protocol-mismatch errors and registry isolation. Drop the global-fetch default test; it only checked default wiring, which the TEI e2e suite also exercises when run.
Breaking changes: - @intx/inference and @intx/types (^0.4.0) are peer dependencies; install them alongside. - ModelRequestError is now RerankRequestError; match on err.reason (InferenceError). - runJSONRequest, extractRetryAfterMs, RunRequestOptions and rerankAdapters are no longer exported. Use rerankAdapterRegistry or createRerankAdapterRegistry. - A missing model for cohere/voyage throws arktype's TraversalError. RerankConfig and wire behavior are unchanged, so existing configs keep working.
TheGreatAxios
force-pushed
the
cl-9172-reranking-rewrite-readme-quickstart-to-rank-concrete-docs
branch
from
September 26, 2026 02:29
e52fb02 to
b3019fc
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.
Summary
@intxpeers, a TEI quickstart with its docker command, Where it fits, a full Reference (exports, config, options, wire formats, errors), Using with Interchange, and Upgrading from 0.1.bun run test:e2e, which CI does not run).e2e/tei.e2e.test.ts;test:e2erunsbun test ./e2e. The global-fetch default unit test is dropped; the e2e suite exercises default deps.Verification
bun install --frozen-lockfile, tsc, lint,bun test ./src(19 tests),prettier --check .and build.tssnippets typecheck against the builtdist.bun run test:e2epasses against a TEI container (bge-reranker-base); CI does not run it.Closes CL-9172
Closes CL-9181
Closes CL-9182
Closes CL-9185