This repository was archived by the owner on Jun 7, 2026. It is now read-only.
docs: update SDK docs for 2.0 breaking changes - #54
Merged
Conversation
- Prefer uv/bun over pip/npm in installation examples - Fix Python SDK examples to use create_koine() factory pattern - Update architecture.md with Python SDK structure - All Python examples now use koine.generate_text() instead of standalone generate_text() which was never exported
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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
uv/bunoverpip/npmin installation examples (with alternatives shown)create_koine()factory pattern instead of standalone functions that were never exportedarchitecture.mdwith Python SDK structureFiles Changed
docs/README.md- Installation and quick start examplesdocs/sdk-guide.md- All Python examples updated to factory patterndocs/architecture.md- Added Python SDK to project structurepackages/sdks/python/README.md- Quick start, features, and API docspackages/sdks/typescript/README.md- Installation exampleTest plan
from koine_sdk import create_koine