Skip to content

docs: rewrite README around a runnable quickstart and quirks table - #16

Merged
TheGreatAxios merged 2 commits into
cl-9211-openai-responses-export-one-plain-factory-and-one-providerfrom
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn
Sep 27, 2026
Merged

TheGreatAxios merged 2 commits into
cl-9211-openai-responses-export-one-plain-factory-and-one-providerfrom
cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Opens with an identity and placement line, a "Why" list, and a single install line including the ^0.4.0 peers.
  • Quickstart streams one turn through createOpenAIResponsesAdapter and surfaces inference.error.
  • Where it fits, an exports table (both provider ids), manifest wiring via loadAdapterRegistry, and Upgrading from 0.1.
  • The sidecar manifest paragraph and Grok example give way to a generic responsesAdapterFactory example, which ignores per-source quirks.
  • Quirks reference table: type, default and request effect for every field.
  • How it works and Development move to CONTRIBUTING.md.
  • Stacked on refactor!: trim the barrel and deprecate the 0.1 provider id #15.

Verification

  • All snippets typecheck against the built package; the quickstart ran against remote Ollama (qwen2.5:7b).
  • Quirks table checked row by row against the resolver and request builder.
  • bun run check passes (40 pass, 2 skip).

Closes CL-9228
Closes CL-9237
Closes CL-9240
Closes CL-9242
Closes CL-9246
Closes CL-9250

@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.

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
TheGreatAxios force-pushed the cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn branch from a5a5601 to 8e83ed1 Compare September 25, 2026 13:50
@TheGreatAxios
TheGreatAxios force-pushed the cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn branch from d28b8de to bee5608 Compare September 25, 2026 17:29
@TheGreatAxios
TheGreatAxios force-pushed the cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn branch from 11194a7 to fbca187 Compare September 25, 2026 22:31
@TheGreatAxios
TheGreatAxios force-pushed the cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn branch from fbca187 to 88609c0 Compare September 25, 2026 22:48
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
TheGreatAxios force-pushed the cl-9228-openai-responses-rewrite-readme-quickstart-to-run-one-turn branch from 88609c0 to c987618 Compare September 26, 2026 01:33
@TheGreatAxios TheGreatAxios changed the title Rewrite README around a runnable quickstart and quirks table docs: rewrite README around a runnable quickstart and quirks table Sep 26, 2026
@TheGreatAxios
TheGreatAxios added this pull request to stack #19 September 26, 2026 01:58
@TheGreatAxios
TheGreatAxios merged commit 951f817 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