Repository navigation
Conversation
…ents Workspace comments have a built-in JSON serializer, so the docs no longer say a custom serializer is needed for them. The serializer hooks example now uses a generic plugin serializer instead. Fixes RaspberryPiFoundation#10266 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 of 3 tasks
gonfunko
approved these changes
Oct 26, 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 #10266
Proposed Changes
Updates
packages/docs/docs/guides/configure/serialization.mdx:WORKSPACE_COMMENTS = 25) is lower than blocks, so they load last.'workspace-comments'to a generic'myPlugin'serializer, with matching function names.{ ... }and sample data in the example JSON output, based on the review feedback on fix: correct workspace comment serialization docs #10270.clearexample to describe whatmyPlugin's clear function would do.Reason for Changes
Workspace comments have had built-in JSON serialization since #7927 (
core/serialization/workspace_comments.ts), so the doc was out of date. The old example also suggested that you still had to register a serializer for comments yourself.Test Coverage
Docs-only change. Ran
npx eslint docs/guides/configure/serialization.mdxinpackages/docs, and it passes. I did not run a full docs site build.Documentation
This PR is the documentation update.
Additional Information
The broken "built-in priorities" link mentioned in the issue was already fixed on
mainby #10405, so this PR doesn't change it.This picks up the work from #10270, which was closed for inactivity, and includes that PR's review feedback.
🤖 Generated with Claude Code