docs: Document LoroDoc.export data format #892
Conversation
This change adds documentation for the LoroDoc.export data format in `docs/export-format.md`. The documentation includes: - An overview of the file structure (header and body). - Details about the header fields: magic bytes, checksum, and encode mode. - A description of the `FastSnapshot` and `FastUpdates` body formats. - References to the relevant source code files for further exploration.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
This change enriches the documentation for the LoroDoc.export data format in `docs/export-format.md`. The updated documentation now includes: - More detail on the checksum calculation (xxhash32 with seed). - An explanation that the data chunks (oplog, state, gc) are stored in an SSTable format. - A high-level overview of the SSTable structure, including its header, block types, and meta section. - An updated "Source Code References" section that includes a link to the `kv-store` crate.
This change adds documentation for the LoroDoc.export data format. It includes details about the overall file structure, header, body, and the different encoding modes.
PR created automatically by Jules for task 3967360466236518918 started by @zxch3n