Skip to content

Commit c0ae432

Browse files
committed
docs: fix the errors and simplify llms.txt
1 parent f658244 commit c0ae432

1 file changed

Lines changed: 6 additions & 108 deletions

File tree

public/llms.txt

Lines changed: 6 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,20 @@ Loro provides JSON-compatible data structures with built-in version control, tim
88

99
- **Website**: https://loro.dev
1010
- **GitHub**: https://github.com/loro-dev/loro
11-
- **Inspector**: https://inspector.loro.dev
12-
- **Examples**: https://github.com/loro-dev/loro-examples-deno
1311

1412
## Core Features
1513

1614
- **Automatic Conflict Resolution**: All concurrent edits converge to the same state using CRDTs
1715
- **Data Types**: Map, List, MovableList, Text (rich/plain), Tree, Counter
1816
- **Version Control**: Git-like checkout, fork, and merge operations
1917
- **Time Travel**: Navigate to any point in document history
20-
- **Rich Text**: Full support for overlapping styles and editor bindings (Quill, ProseMirror, CodeMirror)
21-
- **Performance**: 10-100x faster import than v0.x, handles 25M+ operations efficiently
18+
- **Rich Text**: Full support for overlapping styles and editor bindings (ProseMirror, CodeMirror, Lexical)
2219

2320
## Getting Started
2421

2522
- [Introduction](https://loro.dev/docs): Overview of Loro and its capabilities
2623
- [Quick Start](https://loro.dev/docs/tutorial/get_started): Installation and basic usage with code examples
2724
- [Examples](https://loro.dev/docs/examples): Integration libraries and sample applications
28-
- [LLM Resources](https://loro.dev/docs/llm): AI-friendly documentation
2925

3026
## Tutorials
3127

@@ -93,41 +89,21 @@ Loro provides JSON-compatible data structures with built-in version control, tim
9389
- [Document Size](https://loro.dev/docs/performance/docsize): Storage efficiency analysis
9490
- [Native Performance](https://loro.dev/docs/performance/native): Rust implementation benchmarks
9591

96-
### Key Metrics
97-
- B4 dataset (259k ops): 2.3 seconds processing
98-
- B4x100 (25.9M ops): Successfully handles massive documents
99-
- Import speed: 10-100x faster than v0.x
100-
- Document size: Shallow snapshots provide 75% reduction
101-
10292
## Blog Posts
10393

10494
### Technical Deep Dives
10595
- [Loro v1.0 Release](https://loro.dev/blog/v1.0): Major performance improvements and stable format
10696
- [Rich Text CRDT](https://loro.dev/blog/loro-richtext): Novel algorithm using style anchors
10797
- [Movable Tree](https://loro.dev/blog/movable-tree): Handling complex tree operations
108-
- [CRDT RichText](https://loro.dev/blog/crdt-richtext): Peritext and Fugue implementation
10998
- [Open Source Announcement](https://loro.dev/blog/loro-now-open-source): Loro's journey to open source
11099

111-
## Version History
112-
113-
### Latest Releases
114-
- [v1.5.0](https://loro.dev/changelog/v1.5.0): Advanced hooks, EphemeralStore, multi-threading
115-
- [v1.4.7](https://loro.dev/changelog/v1.4.7): Text styling fixes and uncommitted ops access
116-
- [v1.4.0](https://loro.dev/changelog/v1.4.0): Commit customization and versioning
117-
- [v1.3.0](https://loro.dev/changelog/v1.3.0): Time travel with revertTo()
118-
- [v1.2.0](https://loro.dev/changelog/v1.2.0): Deletion tracking and oplog statistics
119-
- [v1.1.0](https://loro.dev/changelog/v1.1.0): Document forking and container tracking
120-
- [v1.0.0](https://loro.dev/changelog/v1.0.0-beta): First stable release
121-
122-
### Tools
123-
- [Inspector v0.1.0](https://loro.dev/changelog/inspector-v0.1.0): Visual debugging tool release
124100

125101
## Integration Ecosystem
126102

127103
### Editor Bindings
128-
- **loro-prosemirror**: ProseMirror/Tiptap integration
129-
- **loro-codemirror**: CodeMirror 6 integration
130-
- **Quill**: Native binding support
104+
- [**loro-prosemirror**](https://github.com/loro-dev/loro-prosemirror): ProseMirror/Tiptap integration
105+
- [**loro-codemirror**](https://github.com/loro-dev/loro-codemirror): CodeMirror 6 integration
106+
- [**lexical-loro**](https://github.com/datalayer/lexical-loro)
131107

132108
### Language Support
133109
- **Rust**: Native implementation
@@ -136,83 +112,5 @@ Loro provides JSON-compatible data structures with built-in version control, tim
136112
- **Python**: Python bindings
137113
- **C#**: .NET support
138114

139-
## Use Cases
140-
141-
### Ideal For
142-
✅ Collaborative document editing (Google Docs-like)
143-
✅ Real-time multiplayer applications
144-
✅ Offline-first mobile/desktop apps
145-
✅ Distributed systems without central coordination
146-
✅ Applications requiring complete edit history
147-
✅ Peer-to-peer synchronization scenarios
148-
149-
### Not Suitable For
150-
❌ Applications requiring hard invariants (e.g., balance ≥ 0)
151-
❌ Exclusive resource management (booking systems)
152-
❌ ACID transaction requirements
153-
❌ Large binary/media streaming
154-
❌ Bundle-size sensitive applications
155-
156-
## Technical Innovations
157-
158-
### Algorithms
159-
- **Event Graph Walker (Eg-Walker)**: Efficient CRDT with simple indices
160-
- **Fugue**: Minimizes text editing anomalies
161-
- **Movable Tree**: Handles complex tree operations with cycle detection
162-
- **Style Anchors**: Novel rich text implementation
163-
164-
### Design Principles
165-
- Separation of OpLog and DocState for flexibility
166-
- Deterministic container IDs based on context
167-
- Monotonic merging without rejection
168-
- Memory-efficient relay servers (OpLog only)
169-
170-
## Installation
171-
172-
```bash
173-
# NPM/JavaScript
174-
npm install loro-crdt
175-
176-
# Rust
177-
cargo add loro
178-
179-
# Swift Package Manager
180-
dependencies: [
181-
.package(url: "https://github.com/loro-dev/loro-swift", from: "1.5.0")
182-
]
183-
```
184-
185-
## Basic Usage
186-
187-
```javascript
188-
import { LoroDoc } from "loro-crdt";
189-
190-
// Create document
191-
const doc = new LoroDoc();
192-
193-
// Get containers
194-
const text = doc.getText("content");
195-
const map = doc.getMap("metadata");
196-
197-
// Make changes
198-
text.insert(0, "Hello World");
199-
map.set("author", "Alice");
200-
201-
// Synchronize
202-
const updates = doc.export({ mode: "update" });
203-
otherDoc.import(updates);
204-
```
205-
206-
## About
207-
208-
Created by Zixuan Chen and Leon Zhao in 2022 with the vision of empowering local-first software and simplifying collaborative application development.
209-
210-
## Additional Resources
211-
212-
- [About Loro](https://loro.dev/about): Background and acknowledgments
213-
- [Changelog](https://loro.dev/changelog): Complete version history
214-
- [Blog](https://loro.dev/blog): Technical articles and announcements
215-
216-
## Summary
217-
218-
Loro is a production-ready CRDT library that makes building collaborative applications straightforward. It combines theoretical rigor with practical performance, offering features like time travel, version control, and rich text editing while maintaining excellent performance characteristics. The library is particularly suited for applications requiring real-time collaboration, offline editing, and automatic conflict resolution in distributed environments.
115+
### Tools
116+
- [Inspector v0.1.0](https://loro.dev/changelog/inspector-v0.1.0): Visual debugging tool release

0 commit comments

Comments
 (0)