Skip to content

docs: document workflow collaboration feature#755

Closed
RiskeyL wants to merge 9 commits into
mainfrom
docs/collaboration
Closed

docs: document workflow collaboration feature#755
RiskeyL wants to merge 9 commits into
mainfrom
docs/collaboration

Conversation

@RiskeyL
Copy link
Copy Markdown
Contributor

@RiskeyL RiskeyL commented Apr 27, 2026

Summary

  • Add the Collaborate with Teammates user guide (en/zh/ja) covering real-time editing, in-canvas comments, and @mentions. Includes a self-hosted Note callout pointing to the new env vars and a Tip for hiding comments and collaborator cursors via the zoom menu.
  • Document the three new collaboration env vars in en/self-host/configuration/environments.mdx (and zh/ja translations): ENABLE_COLLABORATION_MODE, NEXT_PUBLIC_SOCKET_URL, and updated SERVER_WORKER_CLASS guidance. Includes operational notes on reverse-proxy Upgrade/Connection headers and multi-replica sticky sessions.
  • Sync the Add Comment UI label in zh/ja after upstream localization in fix: improve collaboration dify#35309 (previously English literal in non-EN UIs).
  • Supporting standards updates: tighten the style and formatting guides, add a -avoidance rule for zh translations, fix CJK-Latin spacing in the auto-translation Note template, add Collaboration UI labels (Add Comment, Edit comment, Comment Mode) to the glossary, and document the user-guide-vs-env-var-reference division of responsibility in the dify-docs-guides skill.

Upstream PRs

Copilot AI review requested due to automatic review settings April 27, 2026 06:40
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 27, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds end-user documentation and self-host configuration reference updates for the new workflow collaboration capability, plus supporting writing/translation standards and navigation updates.

Changes:

  • Add new “Workflow Collaboration” user guides in EN/ZH/JA and link them into the docs navigation.
  • Document collaboration-related env vars and operational requirements in EN/ZH/JA environment variable references.
  • Update writing/translation standards (style/formatting, glossary, zh translation rules, translation notice templates) and the dify-docs-guides skill guidance.

Reviewed changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
zh/use-dify/build/workflow-collaboration.mdx New ZH user guide for workflow collaboration (real-time editing, comments, @mentions) with self-host callout.
ja/use-dify/build/workflow-collaboration.mdx New JA user guide for workflow collaboration with self-host callout.
en/use-dify/build/workflow-collaboration.mdx New EN user guide for workflow collaboration with self-host callout.
zh/self-host/configuration/environments.mdx Adds ENABLE_COLLABORATION_MODE section; updates SERVER_WORKER_CLASS guidance; documents NEXT_PUBLIC_SOCKET_URL.
ja/self-host/configuration/environments.mdx Same collaboration env var documentation updates in JA.
en/self-host/configuration/environments.mdx Same collaboration env var documentation updates in EN.
docs.json Adds the new workflow collaboration pages to the sidebar/nav for EN/ZH/JA.
writing-guides/style-guide.md Refines style guidance (conciseness, bullets, headings-first-sentence guidance, feature-name usage).
writing-guides/glossary.md Adds Collaboration UI glossary entries (Add Comment, Edit comment, Comment Mode).
writing-guides/formatting-guide.md Tightens punctuation guidance and adds an em-dash usage checklist item.
tools/translate/formatting-zh.md Adds a ZH translation rule to avoid “请” in “refer to” phrasing.
tools/translate/config.json Updates ZH/JA auto-translation notice templates for improved CJK–Latin/link spacing.
.claude/skills/dify-docs-guides/SKILL.md Documents how user guides should reference env vars (link to reference docs rather than duplicating semantics).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread zh/use-dify/build/workflow-collaboration.mdx
Comment thread ja/use-dify/build/workflow-collaboration.mdx
@RiskeyL RiskeyL closed this Apr 27, 2026
@RiskeyL RiskeyL deleted the docs/collaboration branch April 27, 2026 07:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants