Category
Workspace comments in core were reworked in 2024. They work well in core, but they aren't enabled by default as there's no way for users to add a workspace comment by default. Developers can call a function to register a context menu item that adds a workspace comment, thus making the feature visible to users. This work was originally done in core to fix the half-supported existing workspace comments and allow key partners to unfork the library.
But it's the perfect example of the kind of optional feature that ideally belongs in a plugin. Exactly how much of the code to be removed from core is up for debate as the comments are build on shared UI components. In particular I believe the text editor UI is shared between regular block comments and workspace comments so that should stay in core, but anything used only by workspace comments is probably safe to move to the plugin even if it was written in a general purpose way to be used by other components.
Adding the plugin can be done any time, but removing the corresponding code from core is a breaking change and must be done in a major release only.
Original issue description below:
Component
workspace-comments
Is your feature request related to a problem? Please describe.
Workspace comments exist in core, but they aren't really supported or documented. This is frustrating for external developers who want to use them. It is also frustrating for core developers because they aren't well-integrated.
Describe the solution you'd like
Move the workspace comments to a plugin.
Describe alternatives you've considered
N/A this is what plugins are for :P
Additional context
This should wait until after project-cereal is complete so that you can easily add serialization for the workspace comments.
Marking this as internal until there is serialization support in core.
Category
Workspace comments in core were reworked in 2024. They work well in core, but they aren't enabled by default as there's no way for users to add a workspace comment by default. Developers can call a function to register a context menu item that adds a workspace comment, thus making the feature visible to users. This work was originally done in core to fix the half-supported existing workspace comments and allow key partners to unfork the library.
But it's the perfect example of the kind of optional feature that ideally belongs in a plugin. Exactly how much of the code to be removed from core is up for debate as the comments are build on shared UI components. In particular I believe the text editor UI is shared between regular block comments and workspace comments so that should stay in core, but anything used only by workspace comments is probably safe to move to the plugin even if it was written in a general purpose way to be used by other components.
Adding the plugin can be done any time, but removing the corresponding code from core is a breaking change and must be done in a major release only.
Original issue description below:
Component
workspace-comments
Is your feature request related to a problem? Please describe.
Workspace comments exist in core, but they aren't really supported or documented. This is frustrating for external developers who want to use them. It is also frustrating for core developers because they aren't well-integrated.
Describe the solution you'd like
Move the workspace comments to a plugin.
Describe alternatives you've considered
N/A this is what plugins are for :P
Additional context
This should wait until after project-cereal is complete so that you can easily add serialization for the workspace comments.
Marking this as internal until there is serialization support in core.