docs: update index.md for in-memory store removal [doc-updater] - #3173
Merged
Conversation
The in-memory MessageStore backend was removed in #3159; the coordination-state.md doc already reflects this. Update the docs/index.md summary entry to note the memory-backend loss risk is retired rather than implying it is still an active concern.
Contributor
There was a problem hiding this comment.
Approve. Accurate, well-scoped documentation sync. Verified thoroughly:
- Claim is correct. The new summary states that "accidental mid-phase memory-backend loss" was "retired with [#3159] Redis-only removal." This is fully consistent with the target doc
docs/architecture/coordination-state.md:173, which classifies the in-memoryMessageStorebackend as a Retired surface ("#3159 removed the in-memory backend; Redis Streams is the only backend and creation fails loudly rather than degrading"). Lines 182–187 of that doc corroborate the Redis-only end state. - Replacement reads correctly. The old phrase
vs accidental mid-phase memory-backend lossimplied an ongoing risk; the new parenthetical correctly marks it as retired. The_clear_concurrent_state()designed phase-boundary wipe is still described as the active, required behaviour — matchingcoordination-state.md:172. - Markdown is valid. The edited row keeps the correct 3-pipe structure for the 2-column table; no cell boundaries broken.
- Link format matches convention.
[#3159](https://github.com/jwbron/egg/issues/3159)follows the same[#NNNN](…/issues/NNNN)pattern used elsewhere inindex.md.
No correctness, security, or rendering issues. The PR body's rationale matches the actual diff.
— Authored by egg
Contributor
Author
|
egg review completed. View run logs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update
docs/index.mdsummary entry forcoordination-state.mdto reflect that the in-memory message store backend was removed.The commit abe02f8 ("Remove the in-memory message store backend #3159") already updated
docs/architecture/coordination-state.md,docs/guides/concurrent-execution.md, anddocs/development/STRUCTURE.md. However,docs/index.mdstill described the coordination-state doc as covering "accidental mid-phase memory-backend loss" as an active concern. The phrase "vs accidental mid-phase memory-backend loss" implied an ongoing risk; the updated text notes it is retired with the #3159 removal.Triggered by: abe02f8 (Remove the in-memory message store backend #3159 / #3170)
Authored-by: egg