Add LLM-friendly documentation #816
Conversation
This comprehensive documentation provides: - Complete API reference for Python, JavaScript/TypeScript, and CLI - Code examples for all major functions and classes - Quick start guides and usage patterns - Structured format optimized for LLM consumption The documentation covers all user-facing APIs across the E2B SDK ecosystem, making it easier for developers and AI assistants to understand and use E2B.
|
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| async def create( | ||
| cls, | ||
| template: Optional[str] = None, | ||
| timeout: Optional[int] = None, | ||
| metadata: Optional[Dict[str, str]] = None, | ||
| envs: Optional[Dict[str, str]] = None, | ||
| api_key: Optional[str] = None, | ||
| domain: Optional[str] = None, | ||
| debug: Optional[bool] = None, | ||
| connection_config: Optional[ConnectionConfig] = None | ||
| ) -> "AsyncSandbox" |
There was a problem hiding this comment.
The AsyncSandbox.create() method is missing the @classmethod decorator that's present on the connect() method below it. This inconsistency could lead to confusion since both are intended to be class methods. Adding the decorator would maintain consistency in the API documentation.
| async def create( | |
| cls, | |
| template: Optional[str] = None, | |
| timeout: Optional[int] = None, | |
| metadata: Optional[Dict[str, str]] = None, | |
| envs: Optional[Dict[str, str]] = None, | |
| api_key: Optional[str] = None, | |
| domain: Optional[str] = None, | |
| debug: Optional[bool] = None, | |
| connection_config: Optional[ConnectionConfig] = None | |
| ) -> "AsyncSandbox" | |
| @classmethod | |
| async def create( | |
| cls, | |
| template: Optional[str] = None, | |
| timeout: Optional[int] = None, | |
| metadata: Optional[Dict[str, str]] = None, | |
| envs: Optional[Dict[str, str]] = None, | |
| api_key: Optional[str] = None, | |
| domain: Optional[str] = None, | |
| debug: Optional[bool] = None, | |
| connection_config: Optional[ConnectionConfig] = None | |
| ) -> "AsyncSandbox" |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
Summary
This PR adds comprehensive LLM-friendly documentation (
LLM.md) to the E2B repository. The documentation provides a complete API reference for all E2B components in a format optimized for consumption by Large Language Models and AI assistants.What's Added
Benefits
File Details
LLM.mdTesting
The documentation has been verified to include:
A developer on Askdev.AI requested this update