How exa-protocol/exadrive-sdk works
Main Components
• Core SDK Library: Focus on the "src" directory (especially src/index.ts) where the primary logic resides. This is the heart of the ExaDrive SDK.
• Documentation and Guides: Represent the multiple documentation folders (.gitbook, exacompute-desktop-app, exadrive-dashboard, getting-started, getting-started-with-exacompute) that serve as user and developer guidance explaining how to install, integrate, and use the SDK.
• Build and Configuration: Include nodes for package.json, tsconfig.json, and tsup.config.ts which govern dependencies, TypeScript settings, and bundling configurations.
Relationships & Interactions
• Documentation Flow: Demonstrate that various guides (from exacompute-desktop-app, exadrive-dashboard, and getting-started directories) wrap around the core SDK functionality to educate and support users. These components could be shown as supporting layers that interact indirectly with the core using conceptual flows (not direct code dependencies).
Architectural Patterns and Design Principles
• Modular Design: The code in the SDK is separated from the documentation, build configuration, and usage guides. This separation helps in both development and version management.
• Open Source and Extensibility: Since the itself an open-source tool, highlight its extensible points – for example, clear API definitions (in TypeScript) that facilitate contributions and integrations.