Skip to content

Add ECloud SDK reference documentation#292

Open
MadelineAu wants to merge 4 commits into
mainfrom
pr/add-ecloud-sdk-reference
Open

Add ECloud SDK reference documentation#292
MadelineAu wants to merge 4 commits into
mainfrom
pr/add-ecloud-sdk-reference

Conversation

@MadelineAu

Copy link
Copy Markdown
Collaborator

Create initial ECloud SDK reference documentation with two sections:

Overview

  • SDK overview and capabilities
  • Installation instructions
  • Quick start guide
  • Module descriptions
  • Package exports
  • Environments (Sepolia, Mainnet Alpha) with limitations note
  • TypeScript support
  • Authentication methods
  • Error handling
  • Links to npm package and source code

Client configuration

  • Basic usage examples
  • Custom RPC configuration
  • Configuration options (ClientConfig interface)
  • Authentication methods (environment variable, OS keychain, direct parameter)
  • Client properties
  • Environment details (Sepolia, Mainnet Alpha)
  • Verbose logging
  • Error handling
  • Best practices
  • Private key utilities

Structure

  • Uses overview.md (not index.md) following EigenCloud docs pattern
  • Sidebar configured via _category_.json with label "ECloud SDK"
  • Applied Microsoft Manual of Style guidelines (sentence case, active voice, etc.)
  • Includes links to related guides (billing, quickstart, auth keys)

Source: ecloud@v0.5.0 (https://github.com/Layr-Labs/ecloud)

🤖 Generated with Claude Code

MadelineAu and others added 4 commits May 27, 2026 13:17
Provides comprehensive documentation for Claude Code instances working in this repository, including build commands, architecture overview, documentation structure, custom plugins, redirect patterns, and development workflows.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Documents the hybrid approach for maintaining ecloud SDK reference docs:
- Auto-generated structure from source repo analysis
- Manual curation of examples and best practices
- Update workflow when SDK versions change
- Documentation structure and organization

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds critical context for maintaining ecloud SDK reference docs:
- Explicitly exclude internal-only features (sepolia-dev environment)
- Document environment prerequisites (subscription + ETH required for both)
- Link to billing and prerequisites documentation
- Ensure future maintainers have complete context

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Create initial SDK reference docs with overview and client configuration:

- overview.md: SDK overview, installation, quick start, modules, environments
- client.md: Client creation, configuration, authentication, error handling
- _category_.json: Sidebar configuration (label: ECloud SDK)

Structure follows EigenCloud docs pattern (overview.md not index.md).
Includes Mainnet Alpha limitations note and links to related guides.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@vercel

vercel Bot commented May 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
eigencloud-docs Ready Ready Preview May 28, 2026 4:36am

Request Review

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