Skip to content

docs: add Workspaces documentation across Cloud, Interface, and Subscription pages#1001

Open
lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:workspace-docs
Open

docs: add Workspaces documentation across Cloud, Interface, and Subscription pages#1001
lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:workspace-docs

Conversation

@lin-bot23

@lin-bot23 lin-bot23 commented May 20, 2026

Copy link
Copy Markdown
Contributor

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

  • cloud/workspace.mdx (en/zh/ja) — Complete Workspaces reference page covering:
    • Overview of Personal vs Team workspaces
    • Creating a team workspace (step-by-step)
    • Workspace roles (owner vs member) and their permissions
    • Managing members (invite, remove, revoke invitations)
    • Invite limits and subscription requirements
    • Workspace settings (rename, delete, leave)
    • Switching between workspaces
    • Billing and subscription per workspace
    • URL shortcut parameters (?create_workspace=1, ?invite=TOKEN)
    • FAQ section

Updated pages

  • get_started/cloud.mdx (en/zh/ja) — Added "Team collaboration" card to Key features, Workspace link card near pricing section
  • interface/overview.mdx — Added Tip linking to Workspaces documentation
  • support/subscription/managing.mdx — Added "Personal vs Team workspace subscriptions" section
  • docs.json — Registered cloud/workspace in navigation for all 3 languages

Info sources

All content derived from the frontend source code at src/platform/workspace/:

  • teamWorkspaceStore.ts (MAX_OWNED_WORKSPACES = 10, MAX_WORKSPACE_MEMBERS = 50)
  • useWorkspaceUI.ts (permission matrix for owner/member/personal roles)
  • Dialog components (create, invite, member management, subscription, delete)
  • Invite URL loader and create workspace URL loader composables
  • WorkspaceAuthGate (initialization flow)

Checklist

  • English, Chinese, and Japanese versions
  • No screenshots yet (can be added in a follow-up)

@lin-bot23 lin-bot23 changed the title docs: add Workspaces feature page under Cloud Exclusive docs: add Workspaces documentation across Cloud, Interface, and Subscription pages May 20, 2026
- 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
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds 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.

Changes

Workspace documentation

Layer / File(s) Summary
Workspace guide and navigation
cloud/workspace.mdx, docs.json
Documents Personal and Team workspaces, creation, roles, members, settings, switching, billing, direct URLs, and FAQs; adds the page to English Cloud navigation.
Workspace discovery touchpoints
get_started/cloud.mdx, interface/overview.mdx
Adds workspace collaboration cards, links, and a sidebar tip describing invitations and shared credits.
Workspace subscription guidance
support/subscription/managing.mdx
Clarifies Personal subscription steps and documents Team workspace ownership, credits, seats, switching, and settings-based management.
Interface terminology
interface/overview.mdx
Replaces “closed-source Partner Nodes” with “closed-source API nodes” in the login status description.

Suggested reviewers: comfyui-wiki

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai
coderabbitai Bot requested a review from comfyui-wiki July 22, 2026 05:54

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4970189 and 0761a05.

📒 Files selected for processing (5)
  • cloud/workspace.mdx
  • docs.json
  • get_started/cloud.mdx
  • interface/overview.mdx
  • support/subscription/managing.mdx

Comment thread cloud/workspace.mdx
Comment on lines +71 to +90
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)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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.

Comment thread get_started/cloud.mdx
Comment on lines +35 to +37
<Card title="Team collaboration" icon="users">
Create team workspaces to collaborate with your team members. Share subscription plans, credits, and workflows
</Card>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ 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.

Suggested change
<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.

Comment on lines +29 to +34
| 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 |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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.

Suggested change
| 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant