Skip to content

Add comprehensive documentation and restructure API#25

Merged
rbharvs merged 3 commits intomainfrom
brett/docs
Jun 21, 2025
Merged

Add comprehensive documentation and restructure API#25
rbharvs merged 3 commits intomainfrom
brett/docs

Conversation

@rbharvs
Copy link
Owner

@rbharvs rbharvs commented Jun 21, 2025

Summary

  • Add comprehensive README with installation, usage examples, and architecture documentation
  • Restructure internal modules from flat _defaults.py and _protocols.py to organized _internal/ package
  • Expose core components (Sandbox, OutputBudget, SandboxViolation) as part of public API
  • Remove abstract protocol layer in favor of concrete implementations for better type safety

Test plan

  • All existing tests pass
  • Import statements updated throughout codebase
  • Public API exports verified in __init__.py
  • Documentation examples are accurate

@rbharvs rbharvs merged commit 5c17b58 into main Jun 21, 2025
1 check passed
@rbharvs rbharvs deleted the brett/docs branch June 21, 2025 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant