Skip to content

Conversation

@Meggielqk
Copy link
Collaborator

No description provided.

@Meggielqk Meggielqk added this to the 6.0.0 milestone Nov 10, 2025
@Meggielqk Meggielqk requested a review from Copilot November 14, 2025 03:33
@Meggielqk Meggielqk marked this pull request as ready for review November 14, 2025 03:33
Copilot finished reviewing on behalf of Meggielqk November 14, 2025 03:35
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive design documentation for EMQX's Durable Storage (DS) feature. The documentation explains the architecture, data hierarchy, read/write paths, and use cases for durable sessions and shared subscriptions.

Key Changes

  • Added new design documentation for Durable Storage in three languages (English, Chinese, and Japanese)
  • Updated durability introduction documents to include references to the new design documentation
  • Enhanced architecture explanations with new concepts: Database, Slab, and TTV (Topic-Timestamp-Value)
  • Added real-time subscription diagrams and transaction flow documentation

Reviewed Changes

Copilot reviewed 6 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
en_US/design/durable-storage.md New comprehensive English design document explaining DS architecture, backends, hierarchy, write/read paths, and applications
zh_CN/design/durable-storage.md Chinese translation of the design document with detailed explanations of DS concepts and implementation
ja_JP/design/durable-storage.md Japanese translation matching the English design document structure
en_US/durability/durability_introduction.md Updated to reference the new design doc, clarified "built-in" spelling, expanded architecture section with Database, Slab, and TTV concepts
zh_CN/durability/durability_introduction.md Chinese version updated with similar enhancements and cross-reference to design doc
en_US/design/assets/real-time_subscriptions.png New diagram illustrating real-time subscription architecture (binary PNG file)
zh_CN/design/assets/real-time_subscriptions.png Chinese version of the real-time subscriptions diagram (binary PNG file)
ja_JP/design/assets/real-time_subscriptions.png Japanese version of the real-time subscriptions diagram (binary PNG file)
dir.yaml Added new design/durable-storage entry to the documentation navigation structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ieQu1
Copy link
Member

ieQu1 commented Nov 14, 2025

Hi,

Currently the structure of the documents has some duplication. I think the documentation should be restructured like that:

  1. "Durability Introduction" document that contains high level information on how durability is used to implement persistent sessions, shared subscriptions, etc. Everything that concerns the end user. Ideally, it should not mention terms like "shard", "TTV", etc. Also it would great to minimize usage of term "stream" in the first document to avoid confusion with the new "MQTT streams" feature.
  2. "Durable Storage Design". This document should contain all the technical details. It can mention streams (perhaps calling them "durable storage streams" to avoid confusion with other features).

@Meggielqk Meggielqk requested a review from Copilot November 17, 2025 09:55
Copilot finished reviewing on behalf of Meggielqk November 17, 2025 09:57
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 6 out of 14 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Meggielqk Meggielqk requested a review from Copilot November 19, 2025 02:54
Copilot finished reviewing on behalf of Meggielqk November 19, 2025 02:55
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 6 out of 15 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants