refactor: reorganize SDK structure into sdks/ directory (sync/update-readme) - #10
Open
jumsay wants to merge 4 commits into
Open
Conversation
…tations/python into sdks/ folder BREAKING CHANGE: SDK paths have changed: - typescript-sdk/ -> sdks/typescript/ - implementations/python/ -> sdks/python/ This improves project organization by grouping all SDK implementations under a common sdks/ directory.
Update all documentation and configuration files to reference new SDK locations: - implementations/python -> sdks/python - typescript-sdk -> sdks/typescript
Add comprehensive documentation for the new sdks/ directory structure including: - Overview of Python and TypeScript SDKs - Quick start guides for both SDKs - Migration notice for breaking path changes - Guidelines for adding new language SDKs
There was a problem hiding this comment.
Pull request overview
This PR implements a comprehensive SDK reorganization, moving both TypeScript and Python SDKs into a unified sdks/ directory structure. The change improves organization and scalability by grouping all SDK implementations at the same hierarchy level.
Changes:
- Restructured repository from
typescript-sdk/andimplementations/python/tosdks/typescript/andsdks/python/ - Updated 11 documentation files with new path references
- Added migration script (
update-paths.ps1) to help developers update local references - Introduced new TypeScript SDK implementation with runtime and memory layers
- Added comprehensive test suites for both SDKs
Reviewed changes
Copilot reviewed 13 out of 196 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| update-paths.ps1 | PowerShell script to automate path updates across documentation and configuration files |
| sdks/typescript/turbo.json | Turbo monorepo configuration for TypeScript SDK build pipeline |
| sdks/typescript/packages/core/tsconfig.json | TypeScript compiler configuration for core package |
| sdks/typescript/packages/core/src/runtime.ts | ARAL Runtime (L1) implementation with lifecycle management and health checks |
| sdks/typescript/packages/core/src/runtime.test.ts | Comprehensive test suite for runtime functionality |
| sdks/typescript/packages/core/src/memory.ts | ARAL Memory (L2) with TTL support and GDPR compliance |
| sdks/typescript/packages/core/src/memory.test.ts | Test suite for memory layer including GDPR features |
| sdks/typescript/packages/core/src/index.ts | Main entry point exporting runtime and memory modules |
| sdks/typescript/packages/core/package.json | Updated repository directory path |
| sdks/typescript/package.json | Monorepo root package configuration |
| sdks/typescript/package-lock.json | Complete dependency lock file (4276 lines) |
| sdks/python/tests/test_secure_reasoning.py | New test suite for secure reasoning engine with injection mitigation |
| sdks/python/tests/test_runtime.py | New test suite for Python runtime implementation |
| sdks/python/examples/README.md | Updated path reference from implementations/python to sdks/python |
| sdks/python/docs/quickstart.rst | Updated installation and example paths |
| sdks/python/docs/migration.rst | Updated test reference path |
| sdks/python/docs/examples.rst | Updated example file path |
| sdks/python/docs/api/reasoning.rst | New API documentation for reasoning layer |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
🔄 Overview
This PR implements Option B of the SDK reorganization on the
sync/update-readme-with-github-flowbranch: moving bothtypescript-sdk/andimplementations/python/into a new unifiedsdks/directory.📦 Changes
Structure Changes
Files Modified
🎯 Benefits
IMPORTANT: This is a BREAKING CHANGE for users with local clones or CI/CD references.
Migration Path
For developers:
git pull origin sync/update-readme-with-github-flow # Update any local scripts referencing old pathsFor CI/CD pipelines:
working-directoryfromimplementations/python→sdks/python./implementations/python→./sdks/pythonFor documentation:
implementations/python/→sdks/python/typescript-sdk/→sdks/typescript/✅ Verification
sdks/README.mdupdate-paths.ps1📚 Related
This change was implemented on 3 branches with typescript-sdk:
Review checklist: