refactor: reorganize SDK structure into sdks/ directory (docs/implement-github-flow-strategy) - #9
Open
jumsay wants to merge 4 commits into
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
10 tasks
There was a problem hiding this comment.
Pull request overview
This PR implements a structural reorganization of the SDK directories, moving both typescript-sdk/ and implementations/python/ into a unified sdks/ directory structure. This is a pure refactoring change with no functional modifications, focused on improving project organization and scalability.
Changes:
- Reorganized directory structure:
typescript-sdk/→sdks/typescript/,implementations/python/→sdks/python/ - Updated 25 documentation references to reflect new paths
- Updated package.json repository directory reference
- Added migration automation script (update-paths.ps1)
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 reference updates across documentation and config files |
| sdks/typescript/turbo.json | Turbo monorepo configuration for the TypeScript SDK build system |
| sdks/typescript/packages/core/tsconfig.json | TypeScript compiler configuration for the core package |
| sdks/typescript/packages/core/src/runtime.ts | ARAL Runtime (L1) implementation with lifecycle management and health monitoring |
| sdks/typescript/packages/core/src/runtime.test.ts | Comprehensive test suite for Runtime functionality |
| sdks/typescript/packages/core/src/memory.ts | ARAL Memory (L2) implementation with TTL support and GDPR compliance |
| sdks/typescript/packages/core/src/memory.test.ts | Test suite for Memory layer including GDPR compliance tests |
| sdks/typescript/packages/core/src/index.ts | Main export file for the core package |
| sdks/typescript/packages/core/package.json | Package metadata with updated repository directory path |
| sdks/typescript/package.json | Root package.json for TypeScript monorepo workspace |
| sdks/typescript/package-lock.json | NPM lock file for dependency resolution |
| sdks/python/tests/test_secure_reasoning.py | New test suite for Secure Reasoning Engine (L4) |
| sdks/python/tests/test_runtime.py | New test suite for Python Runtime implementation |
| sdks/python/examples/README.md | Updated example documentation with corrected path references |
| sdks/python/docs/quickstart.rst | Updated quickstart guide with new installation paths |
| sdks/python/docs/migration.rst | Updated migration guide with corrected GitHub links |
| sdks/python/docs/examples.rst | Updated examples documentation with new paths |
| sdks/python/docs/api/reasoning.rst | New API documentation file 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
docs/implement-github-flow-strategybranch: 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 docs/implement-github-flow-strategy # 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: