-
Notifications
You must be signed in to change notification settings - Fork 803
Cms/workspace extensions #7265
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Cms/workspace extensions #7265
Conversation
Hi @hifi-phil Thanks for the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know these were authored by an AI agent, but solid improvements. I feel like there could be a bit more clarity around the boundaries and roles of workspace contexts. I think the way it's worded just feels kind of ambiguous, I'd be questioning it if I was reading as an implementor, for sure.
@@ -1,135 +1,198 @@ | |||
--- | |||
description: Establish an extension to communicate across the application. | |||
description: >- | |||
Learn how to create workspace contexts that provide shared state management and communication between workspace extensions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might consider rephrasing this as "and communication between extensions in the workspace."
My initial impression of the text as-is was that it was saying that contexts managed data inside of the workspace extension, but then that other workspace extensions could also access/interface with the context, too.
Based on text below, that's not the case.
You can add additional Workspace Contexts using the `workspaceContext` Extension Type, which allows you to inject custom logic into your own Workspace or another one. | ||
Workspace Contexts provide: | ||
- **Shared state** scoped to a specific workspace instance | ||
- **Communication layer** between workspace extensions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same thing as above - let's clarify if workspace contexts manage data between sub-extensions inside of the workspace, or if they're also able to act as a public interface for extensions inside of other workspaces.
} | ||
``` | ||
{% endcode %} | ||
|
||
4. Add the following code to the existing `my-element.ts` from the `src`folder: | ||
## View Lifecycle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super helpful section, I'm going to try to keep this in mind as I go through other docs, too.
📋 Description
Fixes #7269
This PR has been generated by AI using Claude Code. First the example in the main UMbraco source was updated with new features, then off the back of this new docs were added and existing ones were improve to match the code base.
I would like to community team to review this and critique the submission. Tell me if its too much, not enough and what constitutes a good article, in addition to the ones already in the guide. This will further allow me to tweak the prompts to make better output.
✅ Contributor Checklist
I've followed the Umbraco Documentation Style Guide and can confirm that:
Product & Version (if relevant)
v16
Deadline (if relevant)
📚 Helpful Resources