docs: document workflow collaboration feature#755
Closed
RiskeyL wants to merge 9 commits into
Closed
Conversation
Contributor
There was a problem hiding this comment.
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-guidesskill 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
en/self-host/configuration/environments.mdx(and zh/ja translations):ENABLE_COLLABORATION_MODE,NEXT_PUBLIC_SOCKET_URL, and updatedSERVER_WORKER_CLASSguidance. Includes operational notes on reverse-proxyUpgrade/Connectionheaders and multi-replica sticky sessions.Add CommentUI label in zh/ja after upstream localization in fix: improve collaboration dify#35309 (previously English literal in non-EN UIs).请-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 thedify-docs-guidesskill.Upstream PRs