docs(readme): reorganise structure and add new integration examples #223
Conversation
Reorganise README for improved readability and discoverability: - Move Development Environment section to the bottom - Convert integrations to collapsible details sections - Add Anthropic Claude integration with toAnthropic() usage - Add OpenAI Responses API integration with toOpenAIResponses() - Include installation commands within each integration section - Add bun as a package manager option throughout - Remove separate "Optional: AI SDK Integration" section The collapsible sections reduce visual clutter while keeping all integration documentation easily accessible. Each integration now includes its required dependencies inline.
commit: |
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the README structure to improve readability and adds documentation for newly integrated AI platforms (Anthropic Claude and OpenAI Responses API). The changes focus on better organization and discoverability of integration examples.
- Moved Development Environment section to the end for better flow
- Added collapsible
<details>sections for each integration to reduce visual clutter - Documented two new integrations: Anthropic Claude (
toAnthropic()) and OpenAI Responses API (toOpenAIResponses()) - Added bun as a package manager option throughout
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| const tools = await toolset.fetchTools(); | ||
|
|
||
| await openai.chat.completions.create({ |
There was a problem hiding this comment.
The variable "openai" is used here but is never defined or instantiated in this code example. An instance of OpenAI should be created before calling openai.chat.completions.create(), similar to how it's done in the OpenAI Responses API example on line 89.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (all 1 issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="README.md">
<violation number="1" location="README.md:51">
P1: Missing OpenAI client instantiation. The `openai` variable is used but never declared. Add `const openai = new OpenAI();` before calling `openai.chat.completions.create()`.</violation>
</file>
Reply to cubic to teach it or ask questions. Re-run a review with @cubic-dev-ai review this PR
|
|
||
| const tools = await toolset.fetchTools(); | ||
|
|
||
| await openai.chat.completions.create({ |
There was a problem hiding this comment.
P1: Missing OpenAI client instantiation. The openai variable is used but never declared. Add const openai = new OpenAI(); before calling openai.chat.completions.create().
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 51:
<comment>Missing OpenAI client instantiation. The `openai` variable is used but never declared. Add `const openai = new OpenAI();` before calling `openai.chat.completions.create()`.</comment>
<file context>
@@ -21,48 +21,94 @@ yarn add @stackone/ai
+
+const tools = await toolset.fetchTools();
+
+await openai.chat.completions.create({
+ model: "gpt-5.1",
+ messages: [
</file context>
| await openai.chat.completions.create({ | |
| const openai = new OpenAI(); | |
| await openai.chat.completions.create({ |
There was a problem hiding this comment.
@ryoppippi this suggestion from Cubic is probably good to apply as is but i'll let you do so
Reorder sections for better logical flow: 1. Installation - how to install the package 2. Usage - basic usage with authentication and account IDs 3. Integrations - framework-specific examples (OpenAI, Anthropic, etc.) 4. Features - advanced functionality 5. Development Environment - contributor setup Users should understand basic usage patterns before seeing framework-specific integration examples.
glebedel
left a comment
glebedel
left a comment
There was a problem hiding this comment.
couple of comments from copilot worth reviewing - LGTM
Resolve README.md conflict by: - Keeping all integration examples (OpenAI, Anthropic, AI SDK, TanStack AI, Claude Agent SDK) - Reorganising structure: Installation → Usage → Integrations → Features - Using collapsible sections for integration examples - Removing dead link to non-existent custom-base-url.ts example
Each integration example already includes its own installation instructions within the collapsible details section.
Each integration example now includes @stackone/ai in the npm install command to ensure users install all required dependencies.
ryoppippi
deleted the
docs/add-anthropic-openai-responses-integration
branch
Summary
Reorganise README for improved readability and add missing integration documentation.
What Changed
<details>sections to reduce visual cluttertoAnthropic()) and OpenAI Responses API (toOpenAIResponses()) examplesWhy
Recent commits added new integrations (Anthropic Claude #208, OpenAI Responses API #206) but the README wasn't updated to document these. The collapsible sections improve discoverability when there are many integration options.
Summary by cubic
Reorganizes the README for easier navigation and adds missing integration examples. Adds a Usage section and moves Integrations after it, plus Anthropic Claude and OpenAI Responses support, collapsible sections, inline install commands, and bun.
New Features
Refactors
Written for commit 8b1484f. Summary will update automatically on new commits.