{"id":31750625,"url":"https://github.com/developer-dao/cloud-docs","last_synced_at":"2025-10-09T15:54:45.154Z","repository":{"id":308684099,"uuid":"954056649","full_name":"Developer-DAO/Cloud-Docs","owner":"Developer-DAO","description":"D_D Cloud Docs","archived":false,"fork":false,"pushed_at":"2025-10-02T05:08:45.000Z","size":795,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-02T07:10:07.933Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Developer-DAO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-24T13:53:02.000Z","updated_at":"2025-08-19T21:43:10.000Z","dependencies_parsed_at":"2025-10-02T07:03:40.469Z","dependency_job_id":"7ceb1440-1cbe-4693-9c64-3253064da0bf","html_url":"https://github.com/Developer-DAO/Cloud-Docs","commit_stats":null,"previous_names":["developer-dao/cloud-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Developer-DAO/Cloud-Docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2FCloud-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2FCloud-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2FCloud-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2FCloud-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Developer-DAO","download_url":"https://codeload.github.com/Developer-DAO/Cloud-Docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2FCloud-Docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001638,"owners_count":26083147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-09T15:54:43.063Z","updated_at":"2025-10-09T15:54:45.145Z","avatar_url":"https://github.com/Developer-DAO.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# D_D Cloud RPC Documentation\r\n\r\n\u003e Comprehensive documentation for D_D Cloud's multi-chain RPC service\r\n\r\nThis repository contains the source code for the D_D Cloud RPC documentation, built with [mdBook](https://rust-lang.github.io/mdBook/).\r\n\r\n## 🚀 Quick Start\r\n\r\n### Prerequisites\r\n\r\n- [Rust](https://rustup.rs/) (latest stable version)\r\n- [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html)\r\n\r\n### Installation\r\n\r\n1. **Clone the repository**\r\n\r\n   ```bash\r\n   git clone https://github.com/jamiebones/rpc-doc-sample\r\n   cd rpc-doc-sample\r\n   ```\r\n\r\n2. **Install mdBook**\r\n\r\n   ```bash\r\n   cargo install mdbook\r\n   ```\r\n\r\n3. **Install mdBook plugins** (optional but recommended)\r\n   ```bash\r\n   cargo install mdbook-linkcheck\r\n   cargo install mdbook-toc\r\n   ```\r\n\r\n### Running Locally\r\n\r\n1. **Serve the book locally**\r\n   ```bash\r\n   mdbook serve\r\n   ```\r\n2. **Open in browser**\r\n\r\n   - Navigate to `http://localhost:3000`\r\n   - The book will auto-reload when you make changes\r\n\r\n3. **Build static files**\r\n   ```bash\r\n   mdbook build\r\n   ```\r\n   - Output will be in the `book/` directory\r\n\r\n## 📁 Project Structure\r\n\r\n```\r\nrpc-docs/\r\n├── book.toml              # mdBook configuration\r\n├── src/                   # Documentation source files\r\n│   ├── SUMMARY.md         # Table of contents\r\n│   ├── introduction.md    # Introduction page\r\n│   ├── getting-started/   # Getting started guides\r\n│   ├── api-reference/     # API documentation\r\n│   ├── methods/           # RPC method documentation\r\n│   │   ├── evm/          # Ethereum-compatible chains\r\n│   │   ├── solana/       # Solana methods\r\n│   │   ├── cosmos/       # Cosmos ecosystem\r\n│   │   ├── near/         # NEAR Protocol\r\n│   │   ├── sui/          # Sui Network\r\n│   │   └── tron/         # TRON Network\r\n│   ├── networks/         # Supported networks\r\n│   ├── examples/         # Code examples\r\n│   │   ├── javascript/   # JavaScript/Node.js\r\n│   │   ├── python/       # Python examples\r\n│   │   ├── go/           # Go examples\r\n│   │   ├── rust/         # Rust examples\r\n│   │   └── curl/         # cURL examples\r\n│   ├── websockets/       # WebSocket documentation\r\n│   ├── advanced/         # Advanced topics\r\n│   ├── troubleshooting/  # Common issues and solutions\r\n│   └── resources/        # Additional resources\r\n├── theme/                # Custom styling\r\n│   ├── custom.css        # Custom CSS styles\r\n│   └── custom.js         # Custom JavaScript\r\n└── book/                 # Generated output (auto-created)\r\n```\r\n\r\n## ✏️ Contributing\r\n\r\n### Adding New Content\r\n\r\n1. **Create new markdown files** in the appropriate `src/` subdirectory\r\n2. **Update `src/SUMMARY.md`** to include your new pages in the navigation\r\n3. **Follow the existing structure** and formatting conventions\r\n\r\n### Editing Existing Content\r\n\r\n1. **Find the relevant `.md` file** in the `src/` directory\r\n2. **Make your changes** using standard Markdown syntax\r\n3. **Test locally** with `mdbook serve`\r\n\r\n### Markdown Guidelines\r\n\r\n- Use **clear, descriptive headings**\r\n- Include **code examples** with proper syntax highlighting\r\n- Add **links** to related sections\r\n- Use **callout boxes** for important information:\r\n\r\n  ```markdown\r\n  \u003e **Note:** This is an important note\r\n\r\n  \u003e **Warning:** This is a warning\r\n  ```\r\n\r\n### Code Examples\r\n\r\nWhen adding code examples, use appropriate language tags:\r\n\r\n````markdown\r\n```javascript\r\n// JavaScript example\r\nconst provider = new ethers.JsonRpcProvider(\"https://rpc.ddcloud.io/eth\");\r\n```\r\n\r\n```python\r\n# Python example\r\nfrom web3 import Web3\r\nw3 = Web3(Web3.HTTPProvider('https://rpc.ddcloud.io/eth'))\r\n```\r\n\r\n```bash\r\n# cURL example\r\ncurl -X POST https://rpc.ddcloud.io/eth \\\r\n  -H \"Content-Type: application/json\" \\\r\n  -d '{\"jsonrpc\":\"2.0\",\"method\":\"eth_blockNumber\",\"params\":[],\"id\":1}'\r\n```\r\n````\r\n\r\n## 🎨 Theming\r\n\r\nThe documentation uses a custom theme with both light and dark modes:\r\n\r\n- **Default**: Light theme\r\n- **Dark mode**: Available via theme toggle\r\n- **Custom styles**: Located in `theme/custom.css`\r\n- **Custom scripts**: Located in `theme/custom.js`\r\n\r\n### Customizing Styles\r\n\r\nTo modify the appearance:\r\n\r\n1. **Edit `theme/custom.css`** for styling changes\r\n2. **Modify CSS variables** for color scheme adjustments\r\n3. **Test changes** with `mdbook serve`\r\n\r\n## 🔧 Configuration\r\n\r\nThe main configuration is in `book.toml`:\r\n\r\n```toml\r\n[book]\r\ntitle = \"D_D Cloud RPC Documentation\"\r\nauthors = [\"D_D Cloud Team\"]\r\ndescription = \"Comprehensive documentation for D_D Cloud's multi-chain RPC service\"\r\n\r\n[output.html]\r\nadditional-css = [\"theme/custom.css\"]\r\nadditional-js = [\"theme/custom.js\"]\r\ndefault-theme = \"navy\"\r\n```\r\n\r\n### Key Features Enabled\r\n\r\n- **Search**: Full-text search functionality\r\n- **Code playground**: Interactive code examples\r\n- **Folding**: Collapsible sections\r\n- **Git integration**: Edit links and repository info\r\n\r\n## 🚀 Deployment\r\n\r\n### GitHub Pages\r\n\r\n1. **Push changes** to the main branch\r\n2. **GitHub Actions** will automatically build and deploy\r\n3. **Site available** at your GitHub Pages URL\r\n\r\n### Manual Deployment\r\n\r\n1. **Build the book**\r\n\r\n   ```bash\r\n   mdbook build\r\n   ```\r\n\r\n2. **Deploy the `book/` directory** to your web server\r\n\r\n### Docker Deployment\r\n\r\n```dockerfile\r\nFROM nginx:alpine\r\nCOPY book/ /usr/share/nginx/html/\r\nEXPOSE 80\r\n```\r\n\r\n## 🛠️ Development Commands\r\n\r\n| Command        | Description              |\r\n| -------------- | ------------------------ |\r\n| `mdbook serve` | Start development server |\r\n| `mdbook build` | Build static files       |\r\n| `mdbook test`  | Test code examples       |\r\n| `mdbook clean` | Clean build artifacts    |\r\n| `mdbook watch` | Watch for changes        |\r\n\r\n## 📝 Writing Guidelines\r\n\r\n### Content Structure\r\n\r\n1. **Start with overview** - Brief introduction to the topic\r\n2. **Provide examples** - Show practical usage\r\n3. **Include parameters** - Document all parameters and responses\r\n4. **Add troubleshooting** - Common issues and solutions\r\n\r\n### API Documentation Format\r\n\r\n````markdown\r\n## method_name\r\n\r\nBrief description of what this method does.\r\n\r\n### Parameters\r\n\r\n| Parameter | Type     | Required | Description              |\r\n| --------- | -------- | -------- | ------------------------ |\r\n| `param1`  | `string` | Yes      | Description of parameter |\r\n| `param2`  | `number` | No       | Optional parameter       |\r\n\r\n### Example Request\r\n\r\n\\```javascript\r\n// Example code here\r\n\\```\r\n\r\n### Example Response\r\n\r\n\\```json\r\n{\r\n\"jsonrpc\": \"2.0\",\r\n\"id\": 1,\r\n\"result\": \"0x...\"\r\n}\r\n\\```\r\n\r\n### Error Codes\r\n\r\n| Code   | Message         | Description                                 |\r\n| ------ | --------------- | ------------------------------------------- |\r\n| -32600 | Invalid Request | The JSON sent is not a valid Request object |\r\n````\r\n\r\n## 🐛 Troubleshooting\r\n\r\n### Common Issues\r\n\r\n**mdBook not found**\r\n\r\n```bash\r\ncargo install mdbook\r\n```\r\n\r\n**Port already in use**\r\n\r\n```bash\r\nmdbook serve --port 3001\r\n```\r\n\r\n**Build fails**\r\n\r\n- Check `book.toml` syntax\r\n- Verify all links in `SUMMARY.md` point to existing files\r\n- Run `mdbook test` to check code examples\r\n\r\n### Getting Help\r\n\r\n- **Documentation**: [mdBook Guide](https://rust-lang.github.io/mdBook/)\r\n- **Issues**: Create an issue in this repository\r\n- **Community**: Join our Discord/Telegram for support\r\n\r\n## 📄 License\r\n\r\nThis documentation is licensed under [MIT License](LICENSE).\r\n\r\n## 🤝 Support\r\n\r\n- **Issues**: [GitHub Issues](https://github.com/your-org/rpc-docs/issues)\r\n- **Discussions**: [GitHub Discussions](https://github.com/your-org/rpc-docs/discussions)\r\n- **Email**: support@ddcloud.io\r\n- **Discord**: [Join our community](https://discord.gg/ddcloud)\r\n\r\n---\r\n\r\n**Happy documenting!** 📚✨\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloper-dao%2Fcloud-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeveloper-dao%2Fcloud-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloper-dao%2Fcloud-docs/lists"}