Repository navigation
Update serialization docs to reflect support for workspace comments #10266
Description
Location
https://docs.blockly.com/guides/configure/serialization/#serializer-hooks
Type
- Text
- Image or Gif
- Other
Suggested content
The "Save and Load" doc serialization.mdx claims that workspace comments are not supported by JSON serialization, but support for this was added in #7927
The stale doc should be updated to remove this claim. The following serializer hooks example should also be renamed to something more applicable, since it uses workspace-comments as an example which could be confusing.
Additional context
No response
Activity
zspriggs commentedon Aug 13, 2026
Bonus: this page also includes a broken link on the text "built-in priorities". The correct link is here. This link fix can also be included on a PR that fixes this issue.
Johnkothapalli commentedon Aug 13, 2026
I’m working on this. I’ll keep it to the documentation scope described here: document built-in workspace-comment JSON serialization, rename the custom serializer example so it no longer implies comments need a plugin, fix the priorities link, and validate the docs lint/format/build.
ritfiz commentedon Oct 24, 2026
@zspriggs - I have added a PR (#10628) that does the following
One minor thing I noticed in the part of "When a serializer is triggered, two things happen" -
It should mention that the
clearandloaddoes not happen for the triggered serializer, but, clear happens for all in the priority order of smallest to largest, and then load happens in the reverse priority order.docs: update serialization docs to reflect support for workspace comm…