mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-07-22 12:25:45 -04:00
main
6 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 Riskey
|
00c3cc3913 |
fix: use Workflow/Chatflow for zh/ja app-type terms and correct CLI pause scope (#860)
* fix: use Workflow/Chatflow for zh/ja app-type mentions Converts translated app-type terms (对话流/聊天流/チャットフロー and app-type 工作流/ワークフロー compounds) to the English product names per the writing rules, syncs headings, nav labels, and stale anchors, fixes CJK spacing around the insertions, and codifies the UI-quote exception in the zh/ja formatting guides. * translate: localize human-input form examples in zh/ja form_content and user_actions titles are author-written display strings, so the zh/ja examples now show them in the reader's language, coherent across the get-form, submit, and SSE-event examples. Identifiers, option values, and status enums stay verbatim. * fix: CLI pause docs cover Chatflow apps too difyctl raises the HITL pause for every app mode (the check precedes mode dispatch in cli/src/commands/run/app/sse-collector.ts, and resume is form-token based), so the pause sections now name Workflow and Chatflow apps in en/zh/ja. Also carries the zh/ja app-type term conversion for the CLI pages. * fix: match action_text to localized titles and add bold spacing Copilot review: the localized SSE examples' human_input_form_filled events now carry the localized action title in action_text (the wire field holds the executed action's title, per the web client mapping), and the zh integrate-knowledge bold app-type terms get the required CJK-adjacency spaces. |
||
|
Riskey
|
7ccb166cb6 |
Docs/new agent experience (#841)
* docs: add New Agent user guide and node tab
* docs: add ENABLE_AGENT_V2 to environment variable reference
* translate: add zh and ja New Agent documentation
* docs: add New Agent navigation groups
* feat: add limits and quotas rule to style guide
* docs: add skill and file upload limits to New Agent guide
* fix: redirect new-agent doc paths from UI links to self-host pages
* docs: add task examples and refine New Agent pages
* docs: update New Agent data security notice per legal
* docs: extend security notice coverage and build note explanation
Surface the legal data security Warning on the Build page and New Agent node tab (en/zh/ja), and explain the build note as the agent's memory across build chats with an example.
* docs: refine New Agent guidance and cross-link from classic Agent
Model note gains the older-model sandbox symptom; node opener differentiates from the classic node; Build page restructured (review bullets, Info callout, section links) with zh/ja synced; classic Agent app page (self-host) gains a New Agent Tip.
* docs: document memory, permissions, and sandbox facts for New Agent
Verified additions: per-conversation memory bounded by the model's context window; Editor-tier permissions for creating and managing agents; unrestricted sandbox network access; version restore excludes the sandbox environment; build note deletion and regeneration behavior.
* docs: rename Roster to Agent page across New Agent docs
The UI removed the Roster concept; the nav entry is now Agent. Updated pages, node tab titles, image alt text, and the ENABLE_AGENT_V2 reference entry in en/zh/ja. Agent Console button labels are unchanged in the UI and stay verbatim.
* docs: add files vs knowledge guidance and restructure page openers
Decision aid for uploading as Files vs connecting a knowledge base (read-in-full vs search), knowledge opener gains relevance and workspace-asset framing, overview and build intros restructured.
* docs: update docker compose container list and add tool prerequisites (#843)
* docs: update docker compose container list and add tool prerequisites
- Add api_websocket and init_permissions to the started-container list per the current compose defaults
- Remove outdated sample outputs for docker compose up and docker compose ps
- Add a callout noting the clone command requires git, curl, and jq, with recovery guidance on command not found errors
- Mirror all changes to zh and ja
* docs: note expected exited status for init_permissions container
* fix: align tools page tab titles across languages and fix anchors
Shorten the Swagger and Workflow tab titles ("Swagger API as Tool" ->
"Swagger API", "Workflow as Tool" -> "Workflow") in en, zh, and ja so all
three languages generate the same tab anchors. Update the inbound links in
output.mdx that pointed at the old Workflow-tab anchor (#workflow-as-tool,
#工作流作为工具, #ワークフローをツールとして利用) to #workflow.
* feat: consolidate and restructure the API reference (Phase 1) (#846)
* docs: correct HITL API integration flow and sync translations
- Fix the claim that the resume endpoint differs per app type (same
endpoint; only the entry endpoint differs)
- Tie workflow_run_id guidance to the human_input_required event
(chatflow message chunks don't carry it)
- Require the same user when resuming the event stream (mismatch
returns 404); add include_state_snapshot and continue_on_pause
guidance
- Note at the capture step that a null form_token means Email delivery
- Soften the upload-time validation claim to file size limits
- Split long paragraphs; align zh endpoint name with the reference page
* fix: correct API references against verified backend behavior
Audit of the Service API specs against dify hotfix/1.15.0-fix.1, with
every change code-verified and the serious items adversarially
confirmed. Applies to en/zh/ja.
- Add curl samples for GET endpoints with required query params
(Mintlify omits query params from generated snippets)
- Document 401 once in every spec's auth scheme description
- Correct wrong facts: workflow run detail returns inputs as a JSON
string; DELETE /conversations requires a JSON body; audio-to-text
accepts audio/{mp3,m4a,wav,amr,mpga} by MIME type; workflow log
created_by_account filters by email; triggered_from values are
app-run/webhook/schedule/plugin; stop endpoints' user semantics
differ per app type
- Remove unreachable docs: phantom text_replace SSE event, annotation
403, file preview endpoint in the workflow spec, invented
score_threshold bounds
- Make upload user optional (DEFAULT-USER fallback), fix upload
response example, add missing invalid_param error
- Declare text_to_speech.autoPlay in parameters responses (prose
values, no response-field enums)
* fix: complete API reference audit for knowledge and completion specs
* feat: add API spec consolidation pipeline
Phase-1 of the API docs consolidation: tooling that merges the five per-app-type Service API specs into one openapi_service.json per language, with every divergence resolved explicitly in resolutions.json and rendering-preserving namespacing for mode-scoped schema families. Includes the audit lint and parity checks (lint taught the new language-prefixed href scheme), hand-merged mode-aware SSE documentation for POST /chat-messages in en/zh/ja, and the New Agent (Beta) virtual nav group with code-verified mode notes.
* feat: consolidate API reference into one spec per language
Emit {en,zh,ja}/api-reference/openapi_service.json (82 ops, 130 components) from the audit-fixed per-app-type specs; wire docs.json to them with explicit per-app-type endpoint lists, x-mint.href URLs (/{lang}/api-reference/{tag}/{summary} with shared English slugs for in-place language switching), 265 redirects covering the legacy en and CJK URLs, per-app-type overview pages including New Agent (Beta), and rewritten legacy API links in 21 MDX bodies. The old five specs per language stay as pipeline input; they are no longer rendered.
* fix: remove dead conversation_completed error from chat specs
ConversationCompletedError is never raised anywhere at the verified 1.15.0 ref (7a4252b3de): controllers catch it, but no service code raises it, so the documented 400 conversation_completed can never fire. Remove the bullet and example from the chat and chatflow /chat-messages docs in en/zh/ja. Found and adversarially confirmed during the New Agent (PR #836) verification; filed on the upstream bug list.
* feat: add membership matrix and restructure nav config
* feat: rename resource tags and update all references
* feat: stamp per-operation availability lines
* feat: wire three-group API navigation
* feat: add app-type page coverage lint
* docs: rewrite chatflow overview as app-type API guide
* docs: polish chatflow overview zh and ja wording
* docs: rewrite workflow overview as app-type API guide
* docs: align workflow overview details across languages
* docs: expand new agent overview into app-type API guide
* docs: use task-oriented heading on new agent overview
* docs: rewrite chatbot and agent overview as app-type API guide
* docs: rewrite text generator overview as app-type API guide
* docs: match end user link text to merged spec summary
* docs: rewrite knowledge overview as app-type API guide
* docs: move knowledge api guide into api reference
* docs: localize ui labels on knowledge overview
* docs: refresh pipeline readme for restructure modes
* docs: name app-type pages in the guides sidebar
* feat: rename zh completion messages tag to match resource framing
* docs: prototype endpoints-first layout on chatflow overview
* docs: correct detail accuracy on chatflow overview
* docs: move human input flow guide into api reference
Move the shared HITL API integration walkthrough from its six per-product
copies into {en,zh,ja}/api-reference/guides/human-input-flow as the first
task guide in the API docs. Guides gains an App Types subgroup (expanded
by default) with the flow guide after it; six redirects cover the old
paths; the Human Input node docs and the chatflow overview link to the
new home.
* fix: update spec links to the moved human input guide
* fix: let spec lint accept mdx guide pages under api-reference
* docs: align chatflow zh and ja overviews to endpoints-first layout
* docs: polish chatflow zh and ja mode terms and hitl wording
* docs: align workflow overviews to endpoints-first layout
* docs: document form expiry path in human input flow guide
* docs: align new agent overviews to endpoints-first layout
* docs: align chatbot and agent overviews to endpoints-first layout
* docs: align text generator overviews to endpoints-first layout
* docs: align knowledge overviews to endpoints-first layout
* docs: correct built-in metadata examples and agent heading
* docs: flatten app-type pages directly under guides
* docs: make guide pages self-contained and trim reference detail
* docs: add get started guide and retire developing-with-apis
* docs: update new agent api behavior for latest main
New Agent behavior re-verified against dify origin/main (f3ba2846):
agent_thought events now stream through the Service API carrying the
model's reasoning steps and tool calls; a new agent_not_published 400
fires on Send Chat Message and Get App Parameters; the files claim is
softened to contents-not-processed (raw references now reach the prompt;
runtime confirmation pending). Streaming-only, message_end metadata, and
the endpoint surface are unchanged.
* docs: audit fixes for get started and human input flow guides
* docs: fix em dash spacing and ja sentence length in get started
* docs: move message_end note to the send endpoint line
* docs: update writing guides and API skill for app-type naming
- Glossary and zh/ja translation guides: Workflow and Chatflow app types stay English (Workflow 应用 / Chatflow アプリ); lowercase workflow localizes to 工作流 / ワークフロー.
- formatting-guide: API reference links use the language prefix with English slugs.
- dify-docs-api-reference skill: Spec Structure documents source specs merged into openapi_service.json by the pipeline.
* feat: add operation sidebar titles and simplify API redirects
- merge_specs stamps x-mint.metadata.sidebarTitle per operation so translated summaries show in the sidebar.
- Redirects reduced to a catch-all to the English API home plus three knowledge-base exceptions.
- memberships, strings, and SSE overrides carry app-type labels (Workflow/Chatflow English, New Agent, API Overviews group).
* docs: correct app-type naming and translations across API specs
- English mode enum labels Chatflow and Workflow apps.
- zh/ja app references use Workflow/Chatflow; New Agent is 新 Agent / 新しい Agent.
- ja knowledge tag データセット becomes ナレッジベース; zh 模型提供商 becomes 模型供应商.
- Regenerate merged openapi_service.json with per-operation sidebar titles.
* docs: add streaming, errors, and end-user identity API guides
- Consume Streaming Responses: response modes, SSE parsing, event dispatch, and reconnect.
- Handle Errors and Rate Limits: the error envelope, status classes, and retry guidance.
- End User Identity: what the user field scopes and why it stays consistent.
- English source with zh and ja translations.
* docs: reconcile API guides and apply app-type naming
- Reader-test fixes and content audit on get-started and the app-type overview pages.
- zh/ja reconciled to the English source.
- Workflow/Chatflow and New Agent naming applied in prose.
* feat: wire API nav and redirects for consolidated guides
- Rename the guides group to API Overviews and register the new guide pages.
- Redirects: catch-all to the English API home plus three product-embedded knowledge-base links to the Knowledge guide.
* fix: normalize zh model-provider term to 模型供应商
Aligns the POSITION_PROVIDER_* descriptions with the canonical glossary term.
* docs: use Info callouts for guide forward-link notes
Wrap the authentication, base URL, and `user` field forward-reference in each app-type guide (agent, chat, chatflow, completion, workflow; en/zh/ja) in an `<Info>` callout.
* refactor: remove one-time analyze mode and verification compose
- Drop the `analyze` mode (design-time spec-overlap analysis) and its helpers; the merge is stable and nothing invokes it.
- Delete `compose.swagger.yml`, the throwaway local code-vs-spec verification stack (flagged in review for inline credentials).
- README: drop the analyze entry and correct the redirect description.
* fix: correct Chatflow naming and reasoning wording in SSE overrides
- Use "Chatflow" (English) for the app type in the `/chat-messages` SSE tables instead of 对话流/チャットフロー, and fix the legacy zh chatflow "对话流工作流" description. Standalone table cells were missed by the earlier app-type rename.
- Describe `reasoning_chunk` as "reasoning content" in en/ja (matching the `reasoning` field and the zh wording) instead of "chain-of-thought".
* docs: refine API guide wording and simplify the human-input example
* docs: standardize Workflow and Chatflow app-type capitalization
Capitalize Chatflow and Workflow when they name an app type; keep "workflow" lowercase for the general engine, graph, or run sense.
* fix: use 供应商 for model provider in the zh Knowledge spec
* fix: rename the Knowledge API nav group to "Knowledge APIs"
* fix: un-deprecate Update Document by Text in the Knowledge spec
* translate: un-deprecate Update Document by Text in zh/ja specs
Mirror the en fix (
|
||
|
Riskey
|
2f88f0f7d2 |
docs: sync Cloud documentation for Dify 1.15.0 (#835)
* docs: add Human Input file inputs and Service API to Cloud docs Port the Phase 2 Human Input docs (file inputs and the Service API integration flow) to the Cloud docs, mirroring the self-host pages. - human-input.mdx (en/zh/ja): add the Single File / File List field type and the file-handling notes; the upload-limit callout states Cloud's fixed limits (documents 15 MB, images 10 MB, audio 50 MB, video 100 MB, up to 10 files) instead of self-host env vars. - hitl-api-integration-flow.mdx (en/zh/ja): new; identical to self-host since the Service API is the same. - docs.json: nest the integration-flow under the Human Input group in all three navs. - zh/ja reuse the self-host translations; only the callout and the /self-host/ links changed. * docs: rewrite Cloud model providers around AI Credits * docs: rewrite Cloud subscription management for 1.15.0 * docs: update Cloud code node limits and XLSX image extraction note * docs: rewrite Cloud team members management for 1.15.0 * docs: apply the 1.15.0 Integrations redesign to Cloud docs * docs: fix workflow API reference for run-level logs and streaming * docs: sync self-host use-dify pages and fix translation debt * docs: align shared tutorials and quick start with 1.15.0 * docs: refine difyctl install examples and workspace reference * docs: rewrite hotkeys page to match current shortcuts * fix: correct broken anchor links for badged headings and tabs * fix: correct env link and Human Input resume identifier * feat: handle heading badges in link-checker slugs * fix: repoint publish-mcp cross-links to the merged MCP section * docs: rename plugin dev CLI to Dify Plugin CLI * docs: refine CLI reference readability and expand --agent * feat: stop format checkers flagging indented list-item content * fix: correct zh/ja custom-endpoint spacing and a list blank line * docs: clarify Cloud model provider install and AI Credits coverage |
||
|
RiskeyL
|
fac1f14766 |
docs: standardize zh/ja terminology and separate Cloud/CE docs
Terminology (en/zh/ja, glossary, termbase, docs.json): - self-hosted deployment term: zh 自托管 → 自部署; ja consolidates on セルフホスト - product and edition names stay English in all languages: Dify Cloud, Dify Enterprise, Dify Premium, Community Edition - "SaaS version" / "Dify SaaS" → Dify Cloud (generic SaaS unchanged) - docs.json product switcher: Cloud label → English; self-host stays localized Cloud/CE audience separation and accuracy: - drop redundant "for self-hosted" / "for Cloud" conditionals within the split trees - authorize-data-source: correct the OAuth default-client claim (no edition gating in code); self-host keeps only the custom client, Cloud reframes both - authorize-data-source: move the Custom OAuth process inside the Custom tab (en/zh/ja); align zh to the Tabs layout - remove the self-hosted-only workflow-collaboration page from the Cloud tree - docs.json: restore the ja Plugin Development "Getting Started" group dropped as a stray "None" Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> |
||
|
Riskey
|
51b9f55bb5 |
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> |
||
|
RiskeyL
|
5c3977dd91 |
refactor: move tutorials and key concepts under learn path
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> |