Skip to content

Conversation

codegen-sh[bot]
Copy link

@codegen-sh codegen-sh bot commented Aug 4, 2025

🎯 Problem Solved

The current Arianee SDK documentation was insufficient for developers to understand when to use which library. This comprehensive developer guide addresses that issue by providing clear guidance on navigating the SDK ecosystem.

📋 What's Added

🚀 Quick Start Decision Tree

  • Interactive decision tree to help developers choose the right package immediately
  • Role-based recommendations (brands, service providers, wallet developers, etc.)

🏗️ Architecture Overview

  • Clear layered architecture diagram showing package relationships
  • Foundation → Protocol → API Clients → Specialized Services → High-Level Abstractions

📦 Package Categories

  • High-Level Abstractions: @arianee/wallet, @arianee/creator
  • Specialized Services: @arianee/token-provider, @arianee/service-provider
  • API Clients: Various API client packages
  • Protocol Layer: Direct blockchain interaction packages
  • Foundation Layer: Core utilities and types

👥 Role-Based Guides

  • Brands & Issuers: Focus on @arianee/creator
  • End Users & Wallet Developers: Focus on @arianee/wallet
  • Service Providers: Focus on @arianee/service-provider
  • Advanced Developers: Protocol-level packages

💡 Common Use Cases

  • E-commerce integration
  • Service provider platforms
  • Mobile wallet apps
  • Enterprise integrations
  • Privacy-focused applications

📚 Comprehensive Package Reference

  • Detailed examples for each package
  • When to use each package
  • Dependencies and relationships
  • Code examples for common operations

🔄 Integration Patterns

  • How to combine packages effectively
  • Migration guides from low-level to high-level abstractions
  • Best practices and common pitfalls

🎯 Key Benefits

  1. Faster Developer Onboarding: Clear decision tree gets developers to the right package quickly
  2. Reduced Confusion: Eliminates guesswork about which package to use
  3. Better Architecture Understanding: Shows how packages work together
  4. Practical Examples: Real-world code examples for each use case
  5. Role-Based Guidance: Tailored recommendations based on developer's role

📁 Files Added

  • DEVELOPER_GUIDE.md - Comprehensive developer guide (774 lines)

🔍 How to Use

Developers can now:

  1. Start with the decision tree to find their package
  2. Follow role-based guides for their specific use case
  3. Reference detailed package documentation with examples
  4. Use integration patterns for complex scenarios

This guide transforms the SDK from "documentation is shit" to a developer-friendly ecosystem with clear navigation paths! 🚀


💻 View my work • 👤 Initiated by @stefdelecAbout Codegen
⛔ Remove Codegen from PR🚫 Ban action checks

- Created detailed developer guide explaining when to use each library
- Added decision tree for quick package selection
- Organized packages by categories and target audiences
- Included role-based guides for brands, developers, and service providers
- Added integration patterns and common use cases
- Provided comprehensive package reference with examples
- Included migration guide and best practices

This guide addresses the issue of poor documentation by providing
clear guidance on which libraries to use and when, making it much
easier for developers to navigate the Arianee SDK ecosystem.
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