[codex] add SDK integration guide pages - #27
Merged
Conversation
|
✅ Clean PR, @calvin-archastro! No blocking findings on
Reply |
calvin-archastro
marked this pull request as ready for review
June 19, 2026 22:41
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.
What Changed
Adds higher-level Python SDK guide pages alongside the generated pdoc API reference so readers do not land directly in the module index. The docs build now renders authored guide markdown into static pages, and the root README links to the hosted docs and guide entry points.
The guide content covers authentication, sync and async client setup, common integration scenarios, and where to pivot into the generated method reference.
Diagrams
No class diagram is included because this is a docs-only PR and does not add or restructure runtime types.
Scope Indicator
Documentation-only for the Python SDK docs site, README, and docs build script.
Risk Assessment
Low risk. The change does not touch generated SDK source or runtime behavior. The main risk is broken static docs rendering, which was checked with the docs build.
User Impact
SDK users get guide pages for authentication and common integration scenarios before diving into the generated API reference.
Testing
bash scripts/build_docs.shgit diff --checksrc/archastrohttp://localhost:4005using the dev harness token flow:users.me()with_tokensync and asyncusers.me()andteams.list()Follow-ups and Known Issues
The existing pdoc warnings for generated functional TypedDict fields with reserved keys are still present and should be fixed in the generator rather than hand-edited in this SDK repo.