fix: correct workspace comment serialization docs - #10270
Open
Johnkothapalli wants to merge 1 commit into
Open
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Welcome! It looks like this is your first pull request in Blockly, so here are a couple of tips:
- You can find tips about contributing to Blockly and how to validate your changes on our developer site.
- We use conventional commits to make versioning the package easier. Make sure your commit message is in the proper format or learn how to fix it.
- If any of the other checks on this PR fail, you can click on them to learn why. It might be that your change caused a test failure, or that you need to double-check the style guide.
Thank you for opening this PR! A member of the Blockly team will review it soon.
zspriggs
requested changes
Aug 14, 2026
zspriggs
left a comment
zspriggs
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the PR! Just a couple of small things to adjust before we merge it.
| // etc... | ||
| ] | ||
| "blocks": {}, | ||
| "myPlugin": {} |
Contributor
There was a problem hiding this comment.
Can you add some fake data here (it can be the same as what the workspaceComments example previously had) to show that normally there'd be content in this final JSON output?
| }, | ||
| // etc... | ||
| ] | ||
| "blocks": {}, |
Contributor
There was a problem hiding this comment.
nit: add a ... between the curly braces to indicate that there's usually content here in the JSON
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
3 participants
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 #10266
Proposed Changes
Reason for Changes
Workspace comments have been serialized by the JSON system since #7927. The existing guide still said users needed to register a custom serializer and used comments as its custom-plugin example, which could lead users to duplicate built-in behavior.
Test Coverage
Documentation-only change.
node node_modules/eslint/bin/eslint.js packages/docs/docs/guides/configure/serialization.mdxnode node_modules/prettier/bin/prettier.cjs --check packages/docs/docs/guides/configure/serialization.mdxnpm run package --workspace=blocklynpm run docs --workspace=blocklynpm run build --workspace=blockly-docsThe production docs build succeeds. It reports existing site-wide broken-link warnings; the corrected serialization-priorities link is not among them.
Documentation
This PR directly updates the Save and load guide.
Additional Information
The workspace lint script quotes its glob in a way Windows passes literally to ESLint, so the same repository ESLint configuration was run directly against the changed MDX file.