docs: rewrite README around a runnable quickstart and quirks table - #16
Merged
TheGreatAxios merged 2 commits intoSep 27, 2026
Conversation
TheGreatAxios
commented
Sep 25, 2026
TheGreatAxios
left a comment
Contributor
Author
There was a problem hiding this comment.
Reviewed against the exports branch. Quickstart typechecks under strict nodenext; every quirks-table row matches the resolver and request builder; peer deps and engines match package.json. check passes. No outstanding findings.
TheGreatAxios
force-pushed
the
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn
branch
from
September 25, 2026 13:50
a5a5601 to
8e83ed1
Compare
TheGreatAxios
force-pushed
the
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn
branch
from
September 25, 2026 17:29
d28b8de to
bee5608
Compare
TheGreatAxios
force-pushed
the
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn
branch
from
September 25, 2026 22:31
11194a7 to
fbca187
Compare
TheGreatAxios
force-pushed
the
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn
branch
from
September 25, 2026 22:48
fbca187 to
88609c0
Compare
One-sentence intro, a single install line that includes the peer dependencies, and a quickstart that streams one turn through createOpenAIResponsesAdapter and fails loudly when the credential is unset. The sidecar manifest paragraph and the Grok-specific example give way to plain registry wiring, a generic responsesAdapterFactory example, and a reference table of every quirk. How it works and Development move to a new contributing guide.
Open with the adapter's identity and placement, list three concrete benefits, and add Where it fits, an exports table, manifest-based Interchange wiring, and Upgrading from 0.1 notes for the removed exports. Note that responsesAdapterFactory ignores per-source quirks.
TheGreatAxios
force-pushed
the
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn
branch
from
September 26, 2026 01:33
88609c0 to
c987618
Compare
TheGreatAxios
added this pull request to stack #19
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
^0.4.0peers.createOpenAIResponsesAdapterand surfacesinference.error.loadAdapterRegistry, and Upgrading from 0.1.responsesAdapterFactoryexample, which ignores per-source quirks.Verification
bun run checkpasses (40 pass, 2 skip).Closes CL-9228
Closes CL-9237
Closes CL-9240
Closes CL-9242
Closes CL-9246
Closes CL-9250