* docs: add the self-host prerequisite to the CLI pages
difyctl login 404s on a default self-hosted deployment because the
/openapi/v1/* surface ships disabled, and with only OPENAPI_ENABLED it
503s at approval. Name both flags before the sign-in steps. Dify Cloud
is unaffected. Also fixes six pre-existing blank-line violations after
code fences in the same pages.
* docs: complete the Integration Trigger rename in ja
The ja tree rendered the node as 統合トリガー in 27 places across 9 files,
while the product UI calls it インテグレーショントリガー. Adopt the UI string.
No inbound links pointed at the four headings whose anchors move.
* fix: repoint contact-sales links to the per-language forms
Enterprise Tips still linked the udify.app webapp. Point each language
at its own HubSpot sales form, per writing-guides/style-guide.md. The
udify.app/chat/abc123 placeholder in user-input.mdx is untouched.
* fix: correct card icons that never rendered
icon="scale" and icon="arrows-exchange" are not FontAwesome 6 names, so
the Legal Pages and Import & Export cards rendered with no icon at all.
Use scale-balanced and right-left.
* docs: use 应用 instead of 应用程序 in the zh docs
The glossary term for app is 应用. 191 occurrences of 应用程序 remained,
mostly in the monitor, workspace and publish trees. The zh UI is itself
split between the two, so this follows the glossary rather than the UI.
* fix: align UI labels and formatting with the product
Max Iterations on the Agent node matched the classic Agent app setting
instead of the node's own label; the ja column said 最大反復数 where the UI
says 最大反復回数. The Run Batch tab was バッチ実行 in a ja tutorial and
Batch Run in en. The tool YAML type list documented 6 of the 14 values
ToolParameterType accepts. Three zh Frame captions disagreed with their
alt text.
* docs: standardize the web app term across all three languages
Use web app / Web 应用 / Web アプリ, lowercase in English body text and
capitalized where a sentence, description or title-case caption starts.
The product UI is split across web app, Web App and WebApp in every
language, so there is no UI spelling to follow; the glossary now carries
the rule. zh also had a third variant, 网页应用, and ja had four missing
CJK-Latin spaces.
On-screen labels stay verbatim: Web App Access Control, the Web App
publish-panel section, Who can access web app. So do the API identifiers
Get App WebApp Settings, whose published slug 18 files link to, plus
getChatWebAppSettings and WebAppSettingsResponse.
The webapp family pages carry their other fixes in this commit too,
since those edits interleave with the term change line by line.
* fix: address review feedback on terminology and frontmatter
Make "web app" plural in the cheatsheet so it parallels "Endpoints" in the same list. Close the zh lesson-10 parenthesis with the full-width mark it was opened with. Add the missing zh description on both chatflow-webapp pages, where en and ja already had one.
The other four review comments asked for descriptions on pages whose en source also lacks one. Those are not translation gaps; they belong to the tree-wide frontmatter pass tracked as DC-58.
* fix: match AI credits to the casing the product uses
The UI renders the label lowercase (modelProvider.card.aiCreditsOption and selector.aiCredits); only the section header quotaLabel is all-caps. Lowercase the term in body prose and in the model-providers description, and leave the two Title Case headings alone.
Safe on every branch this backports to: the capitalized modelProvider.quota was pruned upstream in the commit first tagged 1.15.0, so 1.15.0 through 1.16.1 all carry the same lowercase strings.
* docs: sync docs for CE 1.16.1 (#895)
* docs: scope the new agent node to workflow apps
* docs: add no_audio_uploaded to audio-to-text errors
* docs: document multi-select tool parameters
* chore: add 1.16.1 window vars to env ignore list
* docs: document auth and account env vars newly exposed in docker
* docs: fold dynamic-select into the tool parameter type list
* chore: clarify edition gate and mark upstream table-name typo
* docs: document the agent api token and egress proxy service
* docs: count the agent egress proxy among the new agent services
The Reverse Invocation App page documented App invocation signatures that predate the removal of the top-level `files` argument, so every documented signature, and the Chat example, failed against current Python SDK releases (verified against v0.9.1).
Corrected across the English, Chinese, and Japanese pages: drop the removed `files` argument from the Chat, Workflow, and Completion signatures; add the required `query` argument to Chat and to the Chat example; mark `conversation_id` optional; add the optional `user` argument; and show the `response_mode` defaults (`streaming` for Chat, `blocking` for Workflow and Completion). Signatures now match the SDK runtime definitions.
Closes#872
Closes DC-27
* 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 (6802d5eb) into the zh and ja Knowledge specs, source and merged: drop the deprecated flag and the leading Deprecated notice from the update-by-text operation. It is the canonical text-update route; only Update Document by File stays deprecated.
* fix: repoint tools node links to the Classic Agent tab anchor
The Tool Configuration heading is now nested inside the Classic Agent tab, so #tool-configuration no longer resolves. Point the three Tools-page links (en/zh/ja) at the tab-title anchor instead.
* fix: correct broken bold and dropped text in ja/zh Agent node
Pre-existing classic-content translation flaws surfaced in review: the ja ReAct bold cycle was mangled and missing Thought; the zh Memory sentence had dropped text.
* docs: document New Agent deployment and 1.16.0-rc1 availability
Retire the sandbox-container placeholder. The availability Notes, the node-page Note, and a new environments "New Agent (Beta)" section now point to the Dify 1.16.0-rc1 release, note it's on by default on Docker Compose, and call out DIFY_AGENT_SERVER_SECRET_KEY as the one value to set. Also aligns the ja data-security Warning with the zh single-tenant wording. en/zh/ja.
* fix: relink publish API Integration card to the API reference (#847)
* docs: standardize workflow casing in key-concepts and environments
* translate: apply Workflow/Chatflow app-type naming to zh/ja docs
* translate: sync API-guide copy-edits to zh/ja
* fix: correct New Agent API guide against the current runtime
Verified against feat/agent-v2: the reply streams as agent_message events (not message), list-message agent_thoughts carries the turn's reasoning steps (not empty), uploaded files are surfaced to the agent as downloadable references (not ignored), and /meta tool_icons is empty for New Agent apps. Adds the 1.16.0-rc1 availability pointer to the beta note. en/zh/ja.
* docs: use Tip for New Agent availability callouts and tidy API guides
Switch the New Agent availability callouts (overview, build, node) from Note/Info to Tip; the node callout gains the on-by-default sentence. Tighten the API guide beta Info and restructure the get-started API-key section into bullets. zh/ja synced to the en edits.
* fix: point home page API Reference card at the new API guide
* fix: rename Agent nav references to Agents to match the UI
The main-nav item and its page are now labeled Agents (plural), rendered as a literal in routes.ts and roster/page.tsx. Update the bolded nav/page references across the New Agent guide, node page, and environment reference. en/zh/ja.
* fix: add one-hop developing-with-apis redirects for all URL forms
* fix: document both New Agent reply events in the streaming contract
The New Agent guide said replies stream as agent_message; the Send Chat Message SSE reference and the streaming guide said message. Verified against dify feat/agent-v2 (agent_app/app_runner.py and its unit tests): both fire — the reply streams incrementally as agent_message deltas, then the turn closes with a single message event carrying the complete answer, then message_end, with agent_thought alongside throughout. Document the full sequence on all three surfaces and tell clients to treat the closing message as the final answer rather than appending it. en/zh/ja; merged specs regenerated via the API pipeline (build + wire, coverage clean).
* 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
Replace the per-page "Contributing Section" (previously baked into every plugin-dev page by tools/contributing_in_page.py) with a single custom JS file that Mintlify auto-includes on every page. It derives the GitHub edit URL from the current path at runtime, localizes the labels (en/zh/ja), and injects an "Edit this page | Report an issue" bar above the site footer, so the feature now covers all pages with no per-page markup.
- add contributing-footer.js
- remove the 117 baked-in Contributing Sections under en/zh/ja/develop-plugin
- retire tools/contributing_in_page.py
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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>
Point the datasource development guide's cross-product links at /en/cloud/use-dify/... to match the audience-products navigation.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Migrate the polished English develop-plugin pages from PR #817: heading capitalization, code-fence language tags, blockquote-to-callout conversions, and reworded prose across 39 pages.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Bring in changes merged to main since the branch point: API reference and plugin development updates, the plugin sidebar reorganization with a new choose-plugin-type page, backport tooling, workflow node content updates, and refreshed skill, glossary, and translation config files. Content updates are applied to both Cloud and Self-Host copies and to zh and ja.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Phase 1 of the audience-products restructure. Establishes two-product navigation using Mintlify's products primitive, with content moved into per-product paths so each product has its own URL space.
IA composition: languages > products > tabs > {groups | dropdowns | menu | pages}
Cloud product (3 tabs):
- Use Dify
- Developers (menu: API Reference, CLI)
- Plugin
Self-Hosted product (4 tabs):
- Use Dify (dropdowns: User Guide, Admin Guide [EE placeholder])
- Deploy (dropdowns: Community, Enterprise [EE placeholder])
- Developers (menu: API Reference with User API / Admin API dropdowns, CLI)
- Plugin
Filesystem reorganization (en/zh/ja parallel):
- use-dify, develop-plugin, api-reference moved into cloud/, copied into self-hosted/
- self-host moved into self-hosted/deploy/ce
- 9 misfit pages deleted per audit (subscription-management and knowledge-request-rate-limit removed from Self-Hosted; web-app-access removed from Cloud)
- Placeholder MDX for Admin Guide, EE Deploy, Admin API, CLI
Configuration:
- Theme: maple to luma
- Logo href: https://dify.ai
- Navbar: Blog link + Get Started primary button
References:
- Audit: audit/page-audience-classification.md
- Design: ~/Documents/Work/Drafts/2026-04-30-dify-docs-audience-products-design.md
- Progress: ~/Documents/Work/Drafts/2026-05-14-dify-docs-audience-products-progress.md
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* style: move trailing colons outside bold asterisks
Relocates colons from inside bold markers (`**Start:**`) to after them (`**Start**:`) across en, zh, and ja. Colons that sit inside bold markers can break rendering when adjacent to other inline syntax, so keeping them outside produces more reliable output. Preserves colon width (half-width and full-width) and leaves code fences and inline code spans untouched.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* style: normalize punctuation widths across en, zh, ja
Corrects punctuation width to match the surrounding language: full-width forms (，。：？（）) in Chinese and Japanese prose when adjacent to CJK characters, half-width forms in English prose. Japanese uses 、 for commas. One Latin-heavy list in ja/use-dify/workspace/model-providers.mdx was left untouched because converting only its trailing comma would break visual consistency.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: document frontmatter quoting rule
Replaces the vague "quote values that contain special characters" guidance with a concrete rule: leave values unquoted by default, wrap in double quotes only when the value contains a colon followed by a space. This is the one case where YAML would otherwise misparse the value. Example frontmatter block updated to show bare values.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* style: remove triple-asterisk horizontal rule dividers
Deletes standalone *** divider lines across en, zh, and ja docs. Our pages rely on headings for structure, so horizontal rules add visual noise without carrying meaning. Excludes the versions/ folder and use-dify/knowledge/create-knowledge/import-text-data/readme.mdx where the dividers serve a layout purpose. Code fences are left untouched.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* style: convert -ing headings to base form across en docs
Applies the formatting guide's heading verb rule to ~111 headings and frontmatter titles: `Creating X` becomes `Create X`, `Publishing the Plugin` becomes `Publish the Plugin`, and so on. Preserves noun-phrase gerund headings that name a concept or feature (`Troubleshooting`, `Getting Started`, `Monitoring Data List`, `Streaming Output`, etc.) and skips heading-less gerunds used as adjectives (`Publishing Methods`, `Mounting & Volumes`). Heading numeric prefixes like `### 6.` are handled before verb detection. Also fixes two pre-existing missing-space issues on numbered headings in embedding-in-websites.mdx.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* feat: add English and CJK format-check skills
Adds two post-writing verification skills under .claude/skills/. Each combines a Python linter for mechanical rules with a SKILL.md prose section for judgment-call rules, following the same pattern as dify-docs-terminology-check. The English skill enforces every rule in writing-guides/formatting-guide.md. The CJK skill covers general rules plus the Chinese-specific rules in tools/translate/formatting-zh.md and the Japanese-specific rules in tools/translate/formatting-ja.md, auto-selecting the rule set based on the file path. Both linters skip fenced code blocks, inline code spans, and markdown link syntax where appropriate, and they exempt the translation disclaimer from the cross-language link check so zh/ja pages can continue to link back to their English source.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: centralize post-writing verification in writing-guides index
Moves the canonical list of post-writing checks into writing-guides/index.md so it lives in one place, adds the two new format-check skills to that list, and shortens the Post-Writing Verification section in each writing skill (guides, api-reference, env-vars) to a one-line pointer. Also unwraps a pre-existing hard-wrapped paragraph in the api-reference skill's Cross-API Links section.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: address Copilot review comments
Applies twelve fixes raised in the PR review:
- Corrects the "Veriyfing" typo in a newly-renamed en heading and updates it to the imperative base form (Verify).
- Removes a stray empty secondary frontmatter block from the same file.
- Restores four garbled translation strings that were flagged by the reviewer (ja loop-variable description, ja conversation_id bullet, zh team-member access description, zh annotation-threshold sentence).
- Repairs an unbalanced bold markup in ja/use-dify/workspace/team-members-management.mdx introduced by the earlier bold-colon relocation pass.
- Converts half-width colons to full-width `：` after bold labels adjacent to CJK across 26 ja and 2 zh files (174 occurrences). The earlier bold-colon pass moved the colons outside `**...**` but left them half-width; Japanese and Chinese prose use `：` next to CJK.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: address second round of Copilot review comments
Covers nine findings from the follow-up review:
- Extends the bold-colon width fix to any `**...**:` pattern on a line containing CJK, not only when the bolded text itself contains CJK. Catches 34 occurrences in 11 ja and zh files such as `**CentOS**:`, `**Windows**:`, and `- **Professional**:` where the bolded label is Latin but the surrounding prose is Japanese or Chinese.
- Replaces `左上角` with `左上` in three ja files. The original translation carried over the Chinese term instead of using the natural Japanese form.
- Unquotes 99 frontmatter values across 56 en files that were wrapped in single or double quotes without any `: ` in the value. Converts the four single-quoted values to unquoted, matching the new frontmatter quoting rule documented in the formatting guide.
- Converts one stray `**Vector Search Settings**：` in en/use-dify/knowledge/create-knowledge/setting-indexing-methods.mdx back to `:` so English prose uses half-width punctuation.
- Relaxes `_yaml_needs_quotes()` in both format-check linters to match the documented rule (quote only when the value contains `: `). The previous stricter check flagged cases the guide intentionally left unquoted, which would make the skills report violations that the guide does not treat as errors.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: add image rules to style and formatting guides
* refactor: migrate images to content-domain folder structure
* docs: align image syntax and alt text with new rules across languages
* feat: add anchor validation to internal link checker
* fix: correct stale anchor links in en/zh/ja docs
* refactor: address Copilot feedback on link checker
* fix: fix all broken links
* feat: add link-checking GitHub workflow
* fix: convert relative links to absolute paths in knowledge-pipeline pages
* fix: address Copilot review comments on link checker and ja docs
* feat: split link checks into per-PR internal and weekly external workflows
* recover the original agent strategy docs from old docs repo
* Adjust the navigation order of the plugin dev docs
---------
Co-authored-by: Riskey <riskey47@dify.ai>
* draft
* migrate from old docs repo
* adjust content based on experiencing the feature
* Improvements
* changes upon feedback
* refinements
* zh draft
* add plugin dev docs
* update old links
* add jp docs
* change the position of variables related to multimodal embedding in the environment variable doc
---------
Co-authored-by: Riskey <riskey47@dify.ai>
Riskey