Docs: add missing MetadataStore to store-structure.md - #4968
Open
lmac-1 wants to merge 1 commit into
Open
Conversation
Document createMetadataStore.ts (per-job adaptor metadata cache), correct the store count from 10 to 11, and fix the Pattern 2 example which misattributed updateJob/updateWorkflow as hybrid Y.Doc+Immer when they're pure Pattern 1.
Security Review ✅
|
lmac-1
commented
Jul 14, 2026
| Command → write to Y.Doc/Awareness → produce() for immediate UI → notify() | ||
| (Observer also fires but state already matches = idempotent) | ||
| ``` | ||
| **Note:** this is a hybrid pattern and should be used sparingly — evaluate whether |
Collaborator
Author
There was a problem hiding this comment.
@stuartc this came up when it was reviewing, it suggested making these 2 updates aswell in "Pattern 2 section". Do you agree with them, or should we just keep it to MetaDataStore updates? (I'm conscious of not wanting to add too many unnecessary words)
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
1 participant
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.
Description
store-structure.mdcatalogued only 10 stores butcreateMetadataStore.tswas already wired intoStoreProvider.tsxand undocumented. This PR adds theMetaDataStoreentry, corrects layer/pattern lists and the store count (10 -> 11).It also fixes the Pattern 2 example, which misattributed
updateJob/updateWorkflowas a hybrid Y.Doc + Immer writes when they're actually pure Y.Doc only (Pattern 1); repoints the example at the real hybrid case (removeJobAndClearSelection) and carries forward the "use sparingly" caveat from the store's own header commentValidation steps
Additional notes for the reviewer
AI Usage
Please disclose whether you've used AI anywhere in this PR (it's cool, we just
want to know!):
You can read more details in our
Responsible AI Policy
Pre-submission checklist
/reviewwith Claude Code)
(e.g.,
:owner,:admin,:editor,:viewer)