docs: add Workspaces documentation across Cloud, Interface, and Subscription pages#1001
docs: add Workspaces documentation across Cloud, Interface, and Subscription pages#1001lin-bot23 wants to merge 1 commit into
Conversation
- New cloud/workspace.mdx page covering Personal and Team workspaces - Feature flag availability note included - Fixed member limit to reflect 30-member cap (from teamWorkspaceStore.ts) - Replaced em dashes with colons or periods per style guide - Removed all ja/zh/ko translation files and localized nav entries - Added workspace links to get_started/cloud.mdx, interface/overview.mdx, support/subscription/managing.mdx, and docs.json English navigation
5aec7a5 to
0761a05
Compare
📝 WalkthroughWalkthroughAdds a comprehensive Comfy Cloud Workspaces guide, wires it into documentation navigation and discovery pages, and clarifies Personal versus Team workspace subscription behavior. Also updates interface terminology for closed-source API nodes. ChangesWorkspace documentation
Suggested reviewers: 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cloud/workspace.mdx`:
- Around line 71-90: Update the workspace member-management documentation around
the invite capabilities and “Invite members” steps to describe one consistent
invitation flow: clarify whether Comfy Cloud emails the generated invite link or
whether the owner must share it manually, and ensure the introductory bullet and
numbered steps use that same behavior.
In `@get_started/cloud.mdx`:
- Around line 35-37: Update the “Team collaboration” Card text to describe a
single subscription associated with the Team workspace and shared by its
members, rather than saying members share subscription plans. Preserve the
existing collaboration, credits, and workflows messaging.
In `@support/subscription/managing.mdx`:
- Around line 29-34: Update the “Switching” row in the workspace comparison
table to state that users can switch only among workspaces they can access,
while preserving the existing personal-workspace behavior and avoiding wording
that implies arbitrary team-workspace access.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 653eec03-7f54-4bcb-b8f8-57558be4b5eb
📒 Files selected for processing (5)
cloud/workspace.mdxdocs.jsonget_started/cloud.mdxinterface/overview.mdxsupport/subscription/managing.mdx
| As an owner of a team workspace, you can: | ||
|
|
||
| - **Invite members** by email. An invite link is generated and sent to the recipient. | ||
| - **Remove members** from the workspace | ||
| - **Revoke pending invites** that haven't been accepted yet | ||
|
|
||
| To access member management: | ||
|
|
||
| 1. Open the workspace settings panel (click your workspace avatar, then workspace name) | ||
| 2. Go to the **Members** tab | ||
| 3. Click the **+** button to invite a new member | ||
|
|
||
| #### Invite members | ||
|
|
||
| When you invite a member: | ||
|
|
||
| 1. Enter the recipient's email address | ||
| 2. A unique invite link is generated | ||
| 3. Share the invite link with the recipient | ||
| 4. The recipient accepts the invite by visiting the link (they must have or create a Comfy Cloud account) |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the invitation flow consistent.
The page says the invite link is “sent to the recipient,” but the steps below require the owner to share it manually. Clarify whether Comfy Cloud emails the invite or only generates the link.
🧰 Tools
🪛 LanguageTool
[style] ~73-~73: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...can: - Invite members by email. An invite link is generated and sent to the recip...
(AN_INVITE)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cloud/workspace.mdx` around lines 71 - 90, Update the workspace
member-management documentation around the invite capabilities and “Invite
members” steps to describe one consistent invitation flow: clarify whether Comfy
Cloud emails the generated invite link or whether the owner must share it
manually, and ensure the introductory bullet and numbered steps use that same
behavior.
| <Card title="Team collaboration" icon="users"> | ||
| Create team workspaces to collaborate with your team members. Share subscription plans, credits, and workflows | ||
| </Card> |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Describe the subscription as workspace-scoped.
“Share subscription plans” can imply that members pool or share multiple plans. The workspace guide and support/subscription/managing.mdx instead describe one Team workspace subscription shared by its members.
Suggested wording
- Create team workspaces to collaborate with your team members. Share subscription plans, credits, and workflows
+ Create team workspaces to collaborate with your team members. Use a shared workspace subscription, credits, and workflows📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Card title="Team collaboration" icon="users"> | |
| Create team workspaces to collaborate with your team members. Share subscription plans, credits, and workflows | |
| </Card> | |
| <Card title="Team collaboration" icon="users"> | |
| Create team workspaces to collaborate with your team members. Use a shared workspace subscription, credits, and workflows | |
| </Card> |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@get_started/cloud.mdx` around lines 35 - 37, Update the “Team collaboration”
Card text to describe a single subscription associated with the Team workspace
and shared by its members, rather than saying members share subscription plans.
Preserve the existing collaboration, credits, and workflows messaging.
| | Aspect | Personal Workspace | Team Workspace | | ||
| |-------|-------------------|----------------| | ||
| | **Subscription owner** | You (the user) | Workspace Owner | | ||
| | **Credits** | Your personal credits | Shared across all members | | ||
| | **Multi-seat** | Single seat | Multiple seats (plan-dependent) | | ||
| | **Switching** | Switch to any team workspace | Switch back to personal anytime | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Limit switching to accessible workspaces.
The workspace guide says users select from their own workspace list. “Switch to any team workspace” could incorrectly imply access to arbitrary team workspaces.
Suggested wording
-| **Switching** | Switch to any team workspace | Switch back to personal anytime |
+| **Switching** | Switch to any accessible team workspace | Switch back to Personal anytime |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Aspect | Personal Workspace | Team Workspace | | |
| |-------|-------------------|----------------| | |
| | **Subscription owner** | You (the user) | Workspace Owner | | |
| | **Credits** | Your personal credits | Shared across all members | | |
| | **Multi-seat** | Single seat | Multiple seats (plan-dependent) | | |
| | **Switching** | Switch to any team workspace | Switch back to personal anytime | | |
| | Aspect | Personal Workspace | Team Workspace | | |
| |-------|-------------------|----------------| | |
| | **Subscription owner** | You (the user) | Workspace Owner | | |
| | **Credits** | Your personal credits | Shared across all members | | |
| | **Multi-seat** | Single seat | Multiple seats (plan-dependent) | | |
| | **Switching** | Switch to any accessible team workspace | Switch back to Personal anytime | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@support/subscription/managing.mdx` around lines 29 - 34, Update the
“Switching” row in the workspace comparison table to state that users can switch
only among workspaces they can access, while preserving the existing
personal-workspace behavior and avoiding wording that implies arbitrary
team-workspace access.
Summary
Adds Workspaces documentation across multiple sections of the docs, covering the complete workspace feature set in Comfy Cloud. The workspace feature was already fully implemented in the frontend UI (
src/platform/workspace/) but had no corresponding documentation.Changes
New pages
?create_workspace=1,?invite=TOKEN)Updated pages
Info sources
All content derived from the frontend source code at
src/platform/workspace/:Checklist