docs: add and update json serialization migration - #10267
Merged
Conversation
lizschwab
approved these changes
Aug 12, 2026
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.
The basics
The details
Resolves
Fixes #9468
Proposed Changes
Add JSON serialization migration guide into the docs site.
Also made some edits adjusting the code and wording of the guide, since some of it was outdated:
mutationToDom. There are some issues with removing this function. For example,registerMutatorsverifies that bothmutationToDomanddomToMutationare both absent or present, so removing one would throw an error for anyone usingregisterMutators. These issues are specific to blocks, and don't seem to apply to removing thetoXmlfunction on fields after migrating to JSON.Blockly.Xml.textToDomtoBlockly.utils.xml.textToDomReason for Changes
Previously this document was on Google Docs, which made it impossible for the current team to maintain and a little less visible/accessible for those who needed it. It also needed some updates (details above)
Test Coverage
Claude wrote up some manual tests of the workflows outlined in this doc, I reviewed them
Documentation
n/a
Additional Information