Complete index of all documentation for the Ditto CoT library, organized by category and purpose.
docs/
├── technical/ # Architecture and system design
├── development/ # Getting started and building
├── integration/ # SDK integration and examples
└── reference/ # API reference and schemas
Deep technical content about system architecture, algorithms, and performance.
| Document | Description | Audience |
|---|---|---|
| Architecture | System design, components, and data flow | Developers, Architects |
| CRDT Optimization | Advanced P2P synchronization algorithms | Distributed Systems Engineers |
| Performance | Benchmarks, optimization techniques | Performance Engineers |
Getting started, building, and testing the library.
| Document | Description | Audience |
|---|---|---|
| Getting Started | Quick setup for all languages | New Developers |
| Building | Build procedures and requirements | Contributors |
| Testing | Testing strategies and E2E scenarios | QA Engineers, Contributors |
Real-world usage patterns and SDK integration.
| Document | Description | Audience |
|---|---|---|
| Ditto SDK Integration | Observer patterns and DQL operations | App Developers |
| Rust Examples | Rust-specific patterns and async handling | Rust Developers |
| Java Examples | Java/Android with Spring Boot | Java/Android Developers |
| Migration Guide | Version upgrades and legacy migration | System Administrators |
Complete API documentation, schemas, and troubleshooting.
| Document | Description | Audience |
|---|---|---|
| API Reference | Complete API for all languages | All Developers |
| Schema Reference | Document schemas and validation | System Integrators |
| Troubleshooting | Common issues and solutions | Support Engineers |
Implementation-specific guides and APIs.
| Document | Description | Audience |
|---|---|---|
| Rust README | Rust-specific APIs and patterns | Rust Developers |
| Java README | Java-specific APIs and patterns | Java Developers |
Quick navigation between related topics:
Start Here → Getting Started → Integration Examples → API Reference
Architecture → CRDT Optimization → Performance → Schema Reference
Ditto SDK Integration → Language Examples → Migration Guide → Troubleshooting
Building → Testing → Architecture → API Reference
Beginner:
Intermediate:
Advanced:
Setting Up Development Environment:
Integrating into Applications:
Understanding System Design:
Optimizing Performance:
Migrating Systems:
CRDT: Architecture | CRDT Optimization | Schema Reference
Performance: Performance | CRDT Optimization | Troubleshooting
API: API Reference | Integration Examples | Language READMEs
Testing: Testing Guide | Building | Troubleshooting
Schema: Schema Reference | API Reference | Migration Guide
Integration: Ditto SDK Integration | Examples | Migration
Rust: Rust Examples | Rust README | API Reference
Java: Java Examples | Java README | API Reference
Multi-Language: Architecture | Integration Guide | Schema Reference
| Document | Last Updated | Status | Cross-Links |
|---|---|---|---|
| Architecture | Phase 2 | ✅ Complete | ✅ Linked |
| CRDT Optimization | Phase 2 | ✅ Complete | ✅ Linked |
| Performance | Phase 2 | ✅ Complete | ✅ Linked |
| Getting Started | Phase 2 | ✅ Complete | ✅ Linked |
| Building | Phase 2 | ✅ Complete | ✅ Linked |
| Testing | Phase 2 | ✅ Complete | ✅ Linked |
| Ditto SDK Integration | Phase 3 | ✅ Complete | ✅ Linked |
| Rust Examples | Phase 3 | ✅ Complete | ✅ Linked |
| Java Examples | Phase 3 | ✅ Complete | ✅ Linked |
| API Reference | Phase 3 | ✅ Complete | ✅ Linked |
| Schema Reference | Phase 3 | ✅ Complete | ✅ Linked |
| Troubleshooting | Phase 3 | ✅ Complete | ✅ Linked |
| Migration Guide | Phase 3 | ✅ Complete | ✅ Linked |
Last Updated: Phase 4 - Cross-Reference System Implementation
Total Documents: 13
Cross-Links Added: 100%
Navigation Aids: Complete
For the most up-to-date documentation, always refer to the main README.