Skip to content

Commit 51b9f55

Browse files
RiskeyLclaude
andauthored
docs: align self-host documentation with 1.15.0 Integrations navigation redesign (#820)
* fix: trim broken bold markers repo-wide (zh/ja/en) Remove stray spaces inside `**` delimiters that caused bold to render literally in CJK text (e.g. `**工作流 **` → `**工作流**`). 88 files across cloud/, learn/, and quick-start; self-host files with the same fix are included in the nav-optimize commit. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: update self-host docs for Integrations navigation redesign Align self-host documentation with the 1.15.0 navigation optimization: - Regroup docs.json: new Integrations section (Model Provider, Tools, Custom Endpoint); Workspace shrunk to admin-only pages - Reframe plugins.mdx as Integrations Overview with hub type list, permissions, and EE callout - Merge standalone MCP page into tools.mdx MCP Tool tab; delete build/mcp.mdx (en/zh/ja) - Rename all Settings > Model Provider nav paths to Integrations > Model Provider; Default Model Settings to Default Models; API Extension to Custom Endpoint; Logs & Annotations split into separate Logs and Annotations - Update trigger overview and webhook-trigger: Plugin Trigger to Integration Trigger; enable/disable moved to Monitoring > Triggers - Soften concept-level "plugin" references to "integration" across workspace, knowledge, and build pages - Update glossary and writing guides for new terminology - Fix broken bold markers in self-host zh/ja files (same repo-wide fix as prior commit, for files that also had content changes) Excludes the plugin-trigger.mdx en rewrite (pending review). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: add Start Node page, complete trigger rewrites, and apply review fixes - Add Start Node overview page (en/zh/ja, cloud + self-host) explaining the User Input vs. Trigger choice; nest under a new Start group in docs.json with root page support - Trim Key Concepts to link to the new Start Node page instead of inlining the details - Complete Integration Trigger page rewrite (en/zh/ja) with localized UI strings, trigger integration naming, and subscription flow - Remove "## Introduction" headings from trigger, schedule-trigger, webhook-trigger, and user-input pages (en/zh/ja) - Apply review fixes: user-centric opening for tools.mdx, reframe auto-update sentence in plugins.mdx, bold Client ID/Secret, remove tautological sentence, fix "reusable/reuse" redundancy - Complete remaining API Extension to Custom Endpoint renames in api-extension, cloudflare-worker, and moderation pages - Update termbase_i18n.md to match glossary (Integration Trigger, Integrations, Custom Endpoint, Default Models, Logs/Annotations split) - Add redirects for deleted self-host build/mcp pages Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: remove duplicate model providers from Integrations parenthetical The workspace diagram listed Model Providers as its own line and also inside the Integrations parenthetical. Remove it from the parenthetical to avoid ambiguity. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 49cd7bd commit 51b9f55

229 files changed

Lines changed: 1352 additions & 1849 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/skills/dify-docs-guides/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ This is a team effort. The user brings documentation expertise and user empathy;
5353
- For existing features: verify against the `main` branch of the Dify codebase. The user will provide the codebase path or it will be configured as an additional working directory.
5454
- For new features: the user may specify a development branch. Code may be in flux—when behavior is ambiguous, ask rather than assume.
5555
- Trust the codebase over existing documentation. Existing docs may be outdated or inaccurate.
56+
- **When rewriting an existing page, re-verify every claim you carry over** (permissions, defaults, option lists, navigation paths, behavior). Treat the original page as unverified and confirm each fact against the code before keeping it. The most common failure mode is faithfully reproducing an outdated section.
5657
- **Code presence ≠ working feature.** A code path existing does not guarantee the feature functions end to end. When behavior is inferred from code analysis rather than observed in the running product, flag it as unverified and ask the user to test before documenting it as fact.
5758

5859
## Environment Variables in User Guides

docs.json

Lines changed: 131 additions & 65 deletions
Large diffs are not rendered by default.

en/cloud/use-dify/nodes/start.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Start Node
3+
description: Choose how your workflow begins, on demand or automatically
4+
---
5+
6+
When you create a new workflow, you choose a start node that decides whether the workflow waits for someone to run it or runs on its own.
7+
8+
## User Input
9+
10+
Use [User Input](/en/cloud/use-dify/nodes/user-input) when someone (or an API call) should kick off the workflow and supply information it needs. You define input fields for text, numbers, files, and other data, and downstream nodes reference those values.
11+
12+
Only User Input workflows can be published as web apps, MCP servers, backend service APIs, or reused as tools in other Dify apps.
13+
14+
<Info>
15+
Chatflows always start with User Input. Only Workflows can use triggers.
16+
</Info>
17+
18+
## Trigger
19+
20+
Use a [trigger](/en/cloud/use-dify/nodes/trigger/overview) when the workflow should run automatically, without anyone invoking it. Three types are available:
21+
22+
- **[Schedule Trigger](/en/cloud/use-dify/nodes/trigger/schedule-trigger)**: runs at specified times or intervals.
23+
- **[Integration Trigger](/en/cloud/use-dify/nodes/trigger/plugin-trigger)**: runs when an event occurs in an external system, via a subscription through a trigger integration.
24+
- **[Webhook Trigger](/en/cloud/use-dify/nodes/trigger/webhook-trigger)**: runs when the workflow receives an HTTP request from an external system.
25+
26+
## Switch Between Start Nodes
27+
28+
User Input and triggers are mutually exclusive on a canvas. To switch, right-click the current start node and select **Change Node**, or delete it and add a new one.

en/cloud/use-dify/nodes/trigger/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ sidebarTitle: Overview
1111

1212
A trigger is a type of Start node that lets your workflow run automatically on a schedule or in response to events from external systems (such as GitHub, Gmail, or your own internal systems), rather than waiting for active initiation from a user or an API call.
1313

14-
Triggers are ideal for automating repetitive tasks or integrating your workflow with third-party applications to achieve automatic data synchronization and processing.
14+
Use triggers to automate repetitive tasks or synchronize data with third-party applications.
1515

1616
A workflow can have multiple triggers running in parallel. You can also build several independent workflows on the same canvas, each starting with its own triggers.
1717

en/cloud/use-dify/workspace/readme.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@ Applications you build can use any model providers configured in the workspace,
3636

3737
Workspace roles determine access across all resources:
3838
- **Owners** control billing, model providers, and workspace settings
39-
- **Admins** manage team members and configure models/plugins
39+
- **Admins** manage team members and configure models/plugins
4040
- **Editors** build applications and manage knowledge bases
41-
- **Members** use published applications
42-
43-
## Workspace Navigation
44-
45-
Dify organizes everything around the workspace concept. The main navigation shows Apps, Knowledge, and Tools available in your workspace. Settings contains workspace-wide configurations: Members, Model Providers, Plugins, Billing, and personal Account settings.
41+
- **Members** use published applications

en/cloud/use-dify/workspace/tools.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ sidebarTitle: Tools
44
description: Manage tools that enable LLMs to interact with external services and APIs
55
---
66

7-
Dify tools enable LLMs to interact with external services and APIs, so they can access real-time data and perform actions (e.g., web searches, database queries, or content processing).
8-
9-
Each tool has a clear interface: what inputs it accepts, what action it performs, and what output it returns. This helps LLMs decide when and how to call a tool based on user requests.
7+
Add tools to your apps so the LLM can reach external services and APIs for real-time data, web searches, database queries, or content processing.
108

119
Use tools in:
1210

en/learn/key-concepts.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,13 @@ Build workflow apps to handle single-turn tasks. The webapp interface and API pr
3030
Underneath it all, workflow forms the basis for all other app types in Dify.
3131
</Info>
3232

33-
You can specify how and when to start your workflow. There are two types of Start nodes:
34-
35-
- **[User Input](/en/cloud/use-dify/nodes/user-input)**: Direct user interaction or API call invokes the app.
36-
37-
- **[Trigger](/en/cloud/use-dify/nodes/trigger/overview)**: The application runs automatically on a schedule or in response to a specific third-party event.
38-
39-
User Input and Trigger Start nodes are mutually exclusive—they cannot be used on the same canvas. To switch between them, right-click the current start node > **Change Node**. Alternatively, delete the current start node and add a new one.
40-
41-
<Note>
42-
Only workflows started by User Input can be published as standalone web apps or MCP servers, exposed through backend service APIs, or used as tools in other Dify applications.
43-
</Note>
44-
33+
Every workflow begins with a [start node](/en/cloud/use-dify/nodes/start): either User Input (on-demand, triggered by a user or API call) or a Trigger (automatic, on a schedule or in response to external events).
4534

4635
### Chatflow
4736

48-
Chatflow is a special type of workflow app that gets triggered at every turn of a conversation. Other than workflow features, chatflow comes with the ability to store and update custom conversation-specific variables, enable memory in LLM nodes, and stream formatted text, images, and files at different points throughout the chatflow run.
37+
Chatflow is a special type of workflow app that gets triggered at every turn of a conversation. Other than workflow features, chatflow comes with the ability to store and update custom conversation-specific variables, enable memory in LLM nodes, and stream formatted text, images, and files at different points throughout the chatflow run.
4938

50-
Unlike workflow, chatflow can't use [Trigger](/en/cloud/use-dify/nodes/trigger/overview) to start.
39+
Chatflows always start with User Input.
5140

5241
### Dify DSL
5342

en/self-host/deploy/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ mode: "frame"
5353

5454
<div className="mt-10">
5555
<Tip>
56-
On Dify Enterprise, you can deploy on Kubernetes for high availability, with SSO and multi-workspace management. For more information, [contact sales](https://udify.app/chat/QuwcpW1oBNcfeL55).
56+
On Dify Enterprise, you can deploy on Kubernetes for high availability, with SSO and multi-workspace management. [Contact sales](https://udify.app/chat/QuwcpW1oBNcfeL55) to learn more.
5757
</Tip>
5858
</div>
5959
</div>

en/self-host/use-dify/build/additional-features.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Click **Settings** to pick the model that generates the questions, or write a cu
5252
Convert AI responses to audio. You can configure the language and voice to match your app's audience, and enable **Auto Play** to stream audio automatically as the AI responds.
5353

5454
<Info>
55-
**Text to Speech** uses your workspace's text-to-speech model (set in **Settings** > **Model Provider** > **Default Model Settings**).
55+
**Text to Speech** uses your workspace's text-to-speech model (set in **Integrations** > **Model Provider** > **Default Models**).
5656

5757
The feature only appears in the **Features** panel when a default TTS model is configured.
5858
</Info>
@@ -62,7 +62,7 @@ The feature only appears in the **Features** panel when a default TTS model is c
6262
Enable voice input for the chat interface. When enabled, your end users can dictate messages instead of typing by clicking the microphone button.
6363

6464
<Info>
65-
**Speech to Text** uses your workspace's speech-to-text model (set in **Settings** > **Model Provider** > **Default Model Settings**).
65+
**Speech to Text** uses your workspace's speech-to-text model (set in **Integrations** > **Model Provider** > **Default Models**).
6666

6767
The feature only appears in the **Features** panel when a default STT model is configured.
6868
</Info>
@@ -96,7 +96,7 @@ Filter inappropriate content in user inputs, AI outputs, or both. Choose a moder
9696

9797
- **Keywords**: Define a list of blocked terms. Any match triggers the preset response.
9898

99-
- **API Extension**: Connect a custom moderation endpoint for your own filtering logic.
99+
- **Custom Endpoint**: Connect a custom moderation endpoint for your own filtering logic.
100100

101101
When content is flagged, the app replaces it with a preset response that you define.
102102

@@ -116,7 +116,7 @@ To create and manage your annotations:
116116
![Add Annotation Icon](/images/use-dify/workflow/add-annotation-icon.png)
117117
</Frame>
118118

119-
- In the **Logs & Annotations** > **Annotations** tab, manually add new Q&A pairs, manage existing annotations, and view hit history. Click `...` to bulk import or bulk export.
119+
- In **Annotations**, manually add new Q&A pairs, manage existing annotations, and view hit history. Click `...` to bulk import or bulk export.
120120

121121
<Frame>
122122
![Bulk Annotation Operation](/images/use-dify/workflow/bulk-annotation-operation.png)

en/self-host/use-dify/build/agent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Choose the variable type that matches the input you expect:
7474
<Tab title="API-based Variable">
7575
Fetches variable values from an external API at runtime instead of collecting them from users.
7676

77-
Use it when your prompt needs dynamic data from an external source, such as live weather conditions or database records. See [API Extension](/en/self-host/use-dify/workspace/api-extension/api-extension) for details.
77+
Use it when your prompt needs dynamic data from an external source, such as live weather conditions or database records. See [Custom Endpoints](/en/self-host/use-dify/workspace/api-extension/api-extension) for details.
7878
</Tab>
7979
</Tabs>
8080

@@ -103,7 +103,7 @@ The model decides when and which tools to use based on each query. To guide this
103103
You can disable or remove added tools, and modify their configuration. If a tool requires authentication, select an existing credential or create a new one.
104104

105105
<Info>
106-
To change the default credential, go to **Tools** or **Plugins**.
106+
To change the default credential, go to **Integrations** > **Tools** > **Tool Plugin**.
107107
</Info>
108108

109109
#### Maximum Iterations

0 commit comments

Comments
 (0)