README.md

Design Document

Contents

• Data Structure: CRDT data structures in crdt package
• Document Editing: Local and remote document editing mechanism
• Document Removal: Soft deletion of document
• Tree: Tree CRDT data structure
• Range Deletion in Splay Tree: Rotation-free range deletion algorithm for splay tree
• Presence: For sharing the presence of peers
• PubSub: Client-side event sharing with gRPC server-side stream and PubSub pattern
• Garbage Collection: Deleting unused nodes in CRDT system
• Garbage Collection for Text Type: Garbage collection for text nodes
• Housekeeping: Deactivating outdated clients for efficient garbage collection
• Retention: Clearing unnecessary changes with --backend-snapshot-with-purging-changes flag
• Sharded Cluster Mode: Shard-based server cluster mode with consistent hashing
• MongoDB Sharding: MongoDB sharding with sharding strategy considerations

Maintaining the Document

For significant scope and complex new features, it is recommended to write a Design Document before starting any implementation work. On the other hand, we don't need to design documentation for small, simple features and bug fixes.

Writing a design document for big features has many advantages:

• It helps new visitors or contributors understand the inner workings or the architecture of the project.
• We can agree with the community before code is written that could waste effort in the wrong direction.

While working on your design, writing code to prototype your functionality may be useful to refine your approach.

Authoring Design document is also proceeded in the same contribution flow as normal Pull Request such as function implementation or bug fixing.