Add initial set of doc comments to the SDK #4513
Merged
Conversation
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
…nd Thread docs - Add initial README.md with installation, usage, and resuming thread guides - Add API and usage documentation for Codex and Thread classes - Fix and clarify type exports: use Turn and StreamedTurn as RunResult types - Refactor Thread class fields to be private, update id accessor, add detailed comments - Minor doc cleanups and code structure improvements
…e-sdk # Conflicts: # sdk/typescript/src/thread.ts
…ling and fix type annotations
…Emitted") README.md: clarify thread resumption instructions in typescript SDK docs
bolinfest
approved these changes
Oct 1, 2025
| If you don't have the original `Thread` instance to continue the thread, you can resume a thread by calling `resumeThread()` and providing the thread. | ||
|
|
||
| ```typescript | ||
| const threadId = "..."; |
There was a problem hiding this comment.
I think the SDK should provide an API to list/search threads?
There was a problem hiding this comment.
Not sure just yet. We need to figure out the isolation story a bit more (exec from TUI/vscode) and from different invocations of exec.
…e-sdk # Conflicts: # sdk/typescript/README.md # sdk/typescript/src/exec.ts # sdk/typescript/src/index.ts # sdk/typescript/tests/run.test.ts
…e-sdk # Conflicts: # sdk/typescript/src/exec.ts
pakrym-oai
deleted the
pakrym/add-initial-set-of-doc-comments-to-the-sdk
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Also perform minor code cleanup.