Commit Graph

817 Commits

Author SHA1 Message Date
RiskeyL bc89901416 feat: add per-language landing pages with language switcher
Each language gets a chromeless landing at /{lang}/home, registered as a
hidden first page of that language's Cloud > Use tab so the navbar
language switcher recognizes them as translations of each other. Bare /
redirects to /en/home, and the old-introduction and removed-section
redirects now route by source language to /en/home, /zh/home, or
/ja/home. This replaces the single root index.mdx, whose switcher could
not localize.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-15 20:37:01 +08:00
RiskeyL 824285a749 style: drop disclaimers from landing pages and point logo at docs home
The six zh/ja frame-mode landing pages read as designed surfaces, not
translated articles; the blockquote disclaimer broke the visual flow.
The navbar logo now links to the docs root instead of dify.ai.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-15 11:35:20 +08:00
RiskeyL 31366518e3 chore: keep audit artifacts local
The page-audience-classification working file is untracked and
gitignored instead of shipped in the repo.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 18:55:03 +08:00
RiskeyL 1665ede33d chore: align skills, guides, and tooling with restructured paths
Skill scopes, env-var reference paths, release-sync doc-area mappings,
writing-guide examples, README and AGENTS.md paths, the backport
example, and translate-script examples now use the post-restructure
paths (product-prefixed use-dify, self-host deploy segment).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 18:55:03 +08:00
RiskeyL ef4f1024d4 fix: point contact-sales links to sales chat
All EE contact-sales callouts now link to the sales chat at
udify.app/chat/QuwcpW1oBNcfeL55. Plan-upgrade and plan-comparison
links deliberately keep dify.ai/pricing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 16:06:04 +08:00
RiskeyL 7b96126662 docs: redesign use and deploy overviews as frame-mode landings
Both overview types now share one composition: a two-column hero
(orientation line, primary CTA, quiet secondary links, screenshot on
the Use pages) and a grid of six equal cards ending in a Get Help card
with Discord, GitHub Issues, and Discussions links. Layout CSS is a
shared .uo-* family in style.css; the grid self-adapts between five
and six items.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 16:06:04 +08:00
RiskeyL 92ee8b01e4 fix: remove redundant cloud tag from cloud pages
The CLOUD badge predates the product split; inside the Cloud product
it labels nothing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 16:06:03 +08:00
RiskeyL 78b9f95eb6 feat: add redirects for the audience-products restructure
27 new rules map the published structure to the new one: use-dify to
cloud, self-host groups into deploy/, tutorials and key-concepts and
quick-start to shared trees. The 178 legacy redirect destinations
pointing at moved paths are rewritten to final targets to avoid chains,
and two broken legacy destinations are fixed. web-app-access is
intentionally left without a redirect until its EE docs path exists.
Validated by simulating all 748 live sitemap URLs through the rules.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 16:06:03 +08:00
RiskeyL d3dac18b47 docs: add name-origin note to landing page
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 13:13:06 +08:00
RiskeyL a0b6d98b90 fix: remove dify community forum links
The forum is being taken offline.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 13:12:45 +08:00
RiskeyL 8d0134f93c fix: use canonical workspace term in zh nav group label
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 13:12:45 +08:00
RiskeyL 2e4e909475 docs: rewrite use introductions as section overviews
The introductions carried site-landing content (Quick Start, Forum,
Changelog cards) from before the root landing existed. They now orient
within the Use tab: section cards for Build, Knowledge, Publish,
Monitor, and Workspace, plus a learning pointer for newcomers.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 13:12:45 +08:00
RiskeyL c326e242b0 docs: add self-host deploy overview
Orientation page as the Deploy tab's front door: deployment method
cards, post-deployment pointers, release notes link, and the EE tip.
The root landing's Self-Host card now points here.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 13:12:45 +08:00
RiskeyL 9aa63c030c fix: add missing deploy segment in self-host cross-links
17 links in 15 pages still pointed at the pre-restructure
self-host/{group} paths after the deploy/ce segment removal.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 12:02:23 +08:00
RiskeyL 02278363bc feat: replace navbar blog link with github
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 12:02:15 +08:00
RiskeyL 7103608efd feat: move deploy tab first in self-host navigation
Self-hosters' first task is standing up the instance, so the Self-Host
product now opens on Deploy instead of Use, in all three languages.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 12:02:15 +08:00
RiskeyL 69eb4af55e feat: add site-wide landing page
Root index.mdx in custom mode routing visitors to Quick Start, Dify Cloud,
Self-Host deployment, and shared developer resources. The tab row is hidden
on the landing only via a path-scoped style.css rule.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 12:01:55 +08:00
RiskeyL 572b474d69 style: convert translation disclaimers to blockquote format
Convert the AI-translation disclaimer at the top of every zh and ja page from a Note callout to a lightweight blockquote, dropping the warning emoji while keeping each page's link to its English source.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:24:16 +08:00
RiskeyL 9d0433b113 fix: repair NUL-corrupted links in ja integration pages
Repair malformed markdown links in the Langfuse and API Extension pages where the link target had been replaced by NUL bytes, restoring the langfuse.com and ngrok.com links. The corruption had caused text tools to treat these pages as binary files.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:24:15 +08:00
RiskeyL 9183ba6368 feat: restructure navigation into Use/Deploy/Learn/Develop tabs
Reorganize each product's tabs into a consistent verb set (Use, Deploy, Learn, Develop), with Deploy placed second for Self-Host. Nest the plugin docs under the Develop dropdown and rename its items to API, CLI, and Plugins. Elevate each product's Introduction to the Use tab's front-door Overview, and remove the unused placeholder pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:24:15 +08:00
RiskeyL e5e1d4da67 docs: adopt upstream main PRs into audience-products structure
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>
2026-06-10 14:24:15 +08:00
RiskeyL ec415d7d57 docs: consolidate key concepts and quick start into shared pages
Replace the duplicated per-product getting-started key-concepts and quick-start pages with single shared `{lang}/key-concepts` and `{lang}/quick-start` pages. The quick start is product-neutral: it uses the Cloud fast path with a callout pointing self-hosters to deployment.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:24:15 +08:00
RiskeyL 092c7c7fe8 docs: promote tutorials to shared top-level tree
Move tutorials out of each product's use-dify section into a shared `{lang}/tutorials/` tree referenced by both Cloud and Self-Host, and remove the per-product copies and the tutorial snippets.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:24:15 +08:00
RiskeyL af801c81a5 refactor: remove deploy/ce path segment
Flatten the self-host deploy tree by removing the intermediate `ce` segment, moving quick-start, configuration, advanced-deployments, platform-guides, and troubleshooting up to `self-host/deploy/` across en, zh, and ja.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 14:24:15 +08:00
RiskeyL 9e7ed26576 translate: tailor zh/ja use-dify per audience and clean up formatting 2026-06-06 11:14:44 +08:00
RiskeyL cff8f98b32 docs: finalize cloud/self-host content split for use-dify 2026-06-06 11:14:24 +08:00
RiskeyL 40737579af chore: restore docs.json navigation 2026-06-05 18:53:12 +08:00
RiskeyL 94cb8c2198 docs: replace Enterprise feature detail in CE docs with sales pointers 2026-06-05 18:52:22 +08:00
RiskeyL 7ef910adeb refactor: share tutorial bodies via snippets across products 2026-06-05 18:51:01 +08:00
RiskeyL ba58271a86 docs: rename self-hosted to self-host and tailor remaining sections per audience
Consolidates three previously-split commits that have been reverted for review.
This single commit makes the changes easier to review in one place; the granular
three-commit version is preserved on backup/audience-products-pre-revert if
needed.

Includes:

- Rename the Self-Hosted product path slug from self-hosted to self-host across
  en, zh, and ja product trees (505 file renames). docs.json navigation entries
  and internal MDX cross-reference links updated to match. Display name
  "Self-Hosted" and glossary term unchanged. Legacy /getting-started/install-
  self-hosted redirects preserved.

- Tailor 7 Getting Started + Build pages per audience. Cloud versions drop
  self-hosted env-var blocks; Self-Host versions inline the verified docker-env
  defaults from dify/docker/envs/core-services/shared.env.example
  (UPLOAD_FILE_SIZE_LIMIT, UPLOAD_IMAGE_FILE_SIZE_LIMIT, UPLOAD_AUDIO_FILE_SIZE_
  LIMIT, ENABLE_COLLABORATION_MODE, SERVER_WORKER_CLASS, NEXT_PUBLIC_SOCKET_URL).
  Getting Started quick-start restructured per audience: Cloud signup with AI
  Credits; Self-Host deploy + sign in + bring-your-own model provider.

- Tailor 7 Monitor + Publish + Tutorials pages per audience. monitor/logs gets
  a Scenario 2 plan-tier callout on Cloud; web-app-settings removes the EE
  access-control section on Cloud and keeps it with an Enterprise badge on
  Self-Host; integration version-floor callouts dropped from Cloud and rephrased
  product-neutrally on Self-Host.

Also includes:

- docs.json: metadata.timestamp = true (user edit)
- en/cloud/use-dify/getting-started/quick-start.mdx: simplified Sign Up step intro

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-18 18:17:26 +08:00
RiskeyL f96cfc2506 docs: tailor workflow node pages per audience
Diverge the five Workflow node pages with audience-specific markers into Cloud and Self-Hosted versions:

- code: Cloud removes the Self-Hosted Setup section; Self-Hosted renames it to Sandbox Service, corrects stale output-limit defaults (e.g., 80,000 to 400,000) against CODE_* env vars verified in dify/docker/envs/core-services/shared.env.example, and removes the Cloudflare WAF Frame
- knowledge-retrieval: Cloud reframes rate limits as subscription-plan behavior; Self-Hosted removes plan content and surfaces ATTACHMENT_IMAGE_FILE_SIZE_LIMIT inline
- trigger/overview: Cloud uses Scenario 2 callouts for the Sandbox 2-trigger limit and execution quotas; Self-Hosted removes all plan-tier content
- trigger/plugin-trigger: Cloud keeps Default/Custom OAuth nested tabs; Self-Hosted collapses to Custom-only and promotes scattered TRIGGER_URL callouts into one Prerequisite section
- trigger/webhook-trigger: Cloud folds TRIGGER_URL into an inline sentence; Self-Hosted keeps the env var and surfaces the default http://localhost

Cross-reference links across the affected files updated from /en/use-dify/ to product-prefixed paths.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-18 16:31:29 +08:00
RiskeyL 38a1b04dc7 docs: tailor knowledge pages per audience
Diverge the seven Knowledge pages with audience-specific markers into Cloud and Self-Hosted versions:

- chunking-and-cleaning-text: remove Summary Auto-Gen from Cloud (Self-Hosted-only); drop self-hosted framing
- import-text-data/readme: Cloud uses Pro+Team plan-tier callout for the 50-file batch limit; Self-Hosted inlines env vars (UPLOAD_FILE_BATCH_LIMIT, UPLOAD_FILE_SIZE_LIMIT, etc.)
- sync-from-notion: Cloud notes pre-configured OAuth; Self-Hosted retains manual OAuth setup with standardized headings and env-var fixes
- setting-indexing-methods: Cloud drops Q&A indexing subsection; Self-Hosted drops "self-hosted only" qualifier
- knowledge-pipeline-orchestration: Cloud reframes batch table as plan-scoped; Self-Hosted uses verified docker env defaults (BATCH_UPLOAD_LIMIT removed as Pydantic-only)
- publish-knowledge-pipeline: Cloud uses Pro+Team callout for Sandbox restriction; Self-Hosted removes the restriction entirely
- maintain-knowledge-documents: Cloud keeps auto-disable schedule and Add Chunks paid callout; Self-Hosted keeps Generate Summary unframed

Also rewrite 22 cross-reference links across the affected files from /en/use-dify/ to product-prefixed /en/cloud/ or /en/self-hosted/ paths, and from /en/develop-plugin/ to the product-prefixed equivalents.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-18 16:31:17 +08:00
RiskeyL 4a97ba34e7 docs: tailor workspace pages per audience and add paid-feature callouts
All 6 duplicate-and-tailor pages in workspace/ split per audience:
- readme.mdx
- app-management.mdx
- model-providers.mdx
- personal-account-management.mdx
- plugins.mdx
- team-members-management.mdx

Editorial principles applied throughout:
- Filter out the wrong audience's content (Cloud removes env-var blocks,
  Self-Hosted removes subscription/billing references, etc.)
- Don't restate the audience identity in body prose; address the reader
  directly since they're already in the product-specific docs tree

Style guide updated with three paid-feature callout patterns:
- Whole section is the paid feature: badge inline with heading, no callout
- Paid feature within a mixed section: <Info> callout AFTER the target
  paragraph with explicit subject
- Inline mention: inline <Badge> in the sentence

Plan badges introduced: <Badge color="blue">Professional</Badge>,
<Badge color="blue">Team</Badge>, <Badge color="blue">Enterprise</Badge>.

Notable corrections from audit:
- Multi-workspace creation is Enterprise Edition only (not a default
  capability). Cloud accounts each create one workspace.
- Dify Cloud has Sandbox/Pro/Team only; no Cloud Enterprise plan.
  "Enterprise" always refers to Self-Hosted EE.
- System Providers (Dify-managed) concept removed from Self-Hosted
  entirely; only custom providers exist there.

Agent-dispatched flow surfaced audience markers the audit missed on
personal-account-management.mdx (4 additional markers) and
team-members-management.mdx (2 additional markers).

Reference: ~/Documents/Work/Drafts/2026-05-14-dify-docs-audience-products-progress.md

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 18:45:28 +08:00
RiskeyL cf8ae4cde6 feat: restructure docs into cloud and self-hosted products
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>
2026-05-14 20:48:08 +08:00
Riskey 604bdb8466 style: drop trailing-whitespace and callout-blank-line format rules (#771) 2026-04-30 11:43:46 +08:00
Riskey 4ced86f614 docs: move cookie-domain guidance to troubleshooting faq (#770) 2026-04-30 11:17:11 +08:00
Riskey fa3e219618 docs: add previous-versions section and TOC to readme (#767) 2026-04-29 23:06:06 +08:00
Riskey 66523cf52b docs: 1.14 release follow-up fixes (#766)
* docs: 1.14 fixes for HITL events and Creator Center env vars (#764)

* docs: reorganize chatflow API tags and surface workflow_run_id

* refactor: update internal tooling for dify-graphon repo split

* fix: surface workflow_run_id in HITL stream events

* chore: tighten env-vars skill source-of-truth rule

* docs: document Creator Center env vars

* fix: use language-prefixed paths for non-api-reference links

* fix: drop redundant workflow_run_id from workflow HITL events

* fix: drop format uuid from chatflow HITL workflow_run_id

* docs: small fixes for self-host, workspace, and CJK disclaimers (#765)

* docs: shorten docker-compose section headings

* docs: update Team plan limit and remove Dataset Operator role

* fix: correct Japanese translation errors in workspace docs

* style: align AI translation disclaimers with CJK spacing rules

* style: add missing space between disclaimer link and particle in ja docs

* fix: point zh general-specifications disclaimer to en source

* fix: drop format uuid from chatflow workflow paused event
v1.14.0
2026-04-29 21:47:53 +08:00
Riskey dd89e17178 docs: 1.14 release documentation (#763)
* docs: sync App Toolkit with dify#35442 follow-up settings (#757)

* docs: sync App Toolkit page with follow-up settings PR and UI labels

* fix: correct CJK format linter false positives

* chore: broaden post-writing audit scope to whole documents

* docs: address Copilot review on PR #754

Restore the Tab titles rule in formatting-zh.md, which had been trimmed
to a stub. Drop the First-Mention Rule entry from the terminology-check
skill's Output Format so the report sections match the Checks to
Perform sections (the corresponding check was removed earlier).

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: document workflow collaboration feature (#758)

* docs: add workflow collaboration user guide

* docs: tighten style and formatting guides

* docs: avoid "please" in zh refer-to phrases

* fix: add CJK-Latin spacing in translation notice templates

* docs: add env var coordination to dify-docs-guides skill

* docs: document collaboration environment variables

* style: trim collaboration env var descriptions for consistency

* docs: add zoom menu tip for hiding comments and cursors

* docs: sync collaboration UI labels after upstream localization

* docs: rewrite orchestration logic for cross-workflow node copy-paste (#759)

* docs: rewrite orchestration logic and extend workflow-chatflow overview

* translate: update zh and ja for orchestration logic and overview

* docs: refine orchestration logic node reuse section

* docs: clarify MAX_TREE_DEPTH env var description

* fix: align zh title and body references with the glossary UI label

* fix: align EN node reuse text with zh/ja translations (User Input exception)

Agent-Logs-Url: https://github.com/langgenius/dify-docs/sessions/00e54676-8a43-4b6f-99f8-fef2495b054f

Co-authored-by: RiskeyL <36894937+RiskeyL@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

* docs: note HTTPS requirement for cross-workflow node paste (#761)

* docs: HITL Service API polish and 1.14 release follow-ups (#760)

* feat: add env var ignore-list consumed by the verifier

* docs: add 1.14 env vars and correct drifted defaults

* fix: correct knowledge pipeline datasource-plugins response in api references

* chore: record 1.14 env var traces in deep-dive

* docs: update HITL Service API documentation

* docs: clarify /api-reference/ link convention in formatting guide

* docs: update marketplace publish flow

* fix: drop duplicate workflow_run_id from HITL event data schemas

The three HITL event schemas (StreamEventHumanInputRequired,
StreamEventHumanInputFormFilled, StreamEventHumanInputFormTimeout)
declared `workflow_run_id` inside `data.properties`, but
`HumanInputRequiredResponse` in `api/core/app/entities/task_entities.py`
defines `workflow_run_id` only as a top-level field on the response
(alongside `event` and `task_id`); its inner `Data` class doesn't carry
one. The OpenAPI spec already provides top-level `workflow_run_id` via
the `$ref: StreamEventBase` in the `allOf` composition, so the inline
duplicate was a phantom field that doesn't exist in the actual payload.

Remove the inline `workflow_run_id` from `data.properties` in all three
HITL event schemas across all six spec files. This relies on
`StreamEventBase` to provide `workflow_run_id` at the top level via
composition, matching how every other event schema in this spec handles
it (e.g., `StreamEventWorkflowStarted`).

Reported by Copilot on PR #756.

* fix: address Copilot's review comments

* feat: skip api-reference paths in internal link checker

The /api-reference/... URL convention (no language prefix, derived
from OpenAPI tag/summary) generates pages that Mintlify auto-builds
rather than from filesystem MDX files, so the existing filesystem
resolution logic flags every such link as broken.

Skip both filesystem-existence and anchor validation for any URL
containing /api-reference/, mirroring the existing
anchor_check_skipped behaviour. The convention is documented in
writing-guides/formatting-guide.md.

Caveat: typos in tag or summary slugs will now pass silently. A
follow-up could parse the OpenAPI specs to validate against the
real tag/summary kebab pairs if hand-written api-reference links
become common enough to warrant it.

* fix: correct CORS anchor in ja environments page

Inline link [CORS設定](#cors 設定) used a literal space, but the
heading "CORS 設定" slugifies to "cors-設定" (whitespace replaced
with hyphen). Update the anchor to #cors-設定.

* fix: align datasource-plugins is_published and 200 description with node framing

* fix: clarify chatflow stream workflow events task_id origin

* docs: address HITL Service API reader-test feedback

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
2026-04-29 11:57:59 +08:00
Luyu Zhang 27bf0c67c1 chore(ci): migrate runners to depot 2026-04-26 11:28:45 -07:00
Riskey 9e911e1687 docs: clarify yearly-only rule for dify education discount (#753)
* docs: clarify yearly-only rule for dify education discount

* docs: add mdx $ escape rule and billing glossary entries

* fix: clarify $ escape examples show source markdown
2026-04-24 11:55:39 +08:00
Riskey 23905eb42d chore: bulk formatting cleanup and post-writing format-check skills (#751)
* 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>
2026-04-17 22:46:55 +08:00
Riskey 7b291e5e27 chore: exclude versions/ from publish and remove stale redirects (#749) 2026-04-16 21:45:25 +08:00
Riskey a9ac05ed6c style: migrate image assets to content-domain layout and align docs with new image rules (#747)
* 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
2026-04-16 21:23:57 +08:00
Riskey 8c5ca8f6d1 feat: add anchor validation to internal link checker (#748)
* 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
2026-04-16 21:17:24 +08:00
Riskey b94ec219e8 docs: rewrite variable aggregator node page (#745)
* docs: rewrite the variable aggregator node page

* translate: update variable aggregator page for zh and ja

* fix: address review feedback on variable aggregator page

Remove trailing whitespace in en page and restore translation
disclaimers on zh and ja pages for consistency with other translated
node pages.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* docs: require translation disclaimer on all zh/ja pages

Add a Translation Disclaimer section to both zh and ja formatting
guides. Every translated page must include the disclaimer regardless
of review status, since the English source is always canonical and
readers benefit from a consistent pointer on every page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* docs: clarify variable aggregator usage in trigger pages

Simplify the guidance on using a Variable Aggregator to converge
plugin and webhook trigger branches. Align zh and ja translations
with the glossary term (变量聚合器 / 変数集約器).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-15 11:58:07 +08:00
Riskey 7cea249f73 docs: rewrite external knowledge base documentation (#737)
* docs: rewrite external knowledge base overview page

* docs: rewrite external knowledge API specification

* style: add adjustable parameter guidance pattern

* fix: standardize "similarity score" terminology across docs and glossary

* fix: address Copilot's PR review feedback on external knowledge base docs

* translate: sync zh/ja external knowledge base pages with English rewrite

* style: add standard phrase translation convention for zh docs

* fix: address Copilot's PR review feedback on external knowledge base docs

* docs: strengthen codebase verification rule for rewrites

* docs: elevate cross-reference anchor rule in translation guides

* style: add vague cross-references pattern to style guide

* fix: remove filler content from external knowledge base pages

* fix: correct anchor examples in translation formatting guides

* fix: translate code block examples and remove invalid operators in zh/ja API spec

* docs: add translation quality rules for EN→ZH/JA

* docs: move LlamaCloud setup to tip and remove Connection Example section

* translate: sync zh/ja with LlamaCloud restructure and apply new quality rules
2026-04-15 10:26:52 +08:00
99 758be646df fix: block internal files from mintlify publish (#744)
* fix: block internal files from mintlify publish

* fix: restore missing rules in AGENTS.md from CLAUDE.md

---------

Co-authored-by: RiskeyL <7a8y@163.com>
2026-04-13 13:21:37 +08:00
Riskey b6f87ac5d4 docs: rewrite Output node page with zh/ja translations and glossary updates (#742)
* docs: rewrite Output node page and add API mode glossary terms

* translate: sync zh/ja Output node pages with rewritten English source

* style: add link spacing rule for ja and expand anchor rule to cover Tab titles

* fix: remove trailing whitespace in en and replace em dashes in zh
2026-04-10 16:37:39 +08:00
Riskey 83fc9593fa docs: document datasource_info_list schemas and improve Run Pipeline API (#741)
* docs: document datasource_info_list per-type schemas for Run Pipeline API

* docs: improve Run Pipeline parameter descriptions and SSE event documentation

* translate: sync zh/ja pipeline API specs with English schema updates

* fix: address Copilot's PR review feedback on pipeline API docs

* style: add punctuation spacing and API cross-link rules to translation guides
2026-04-10 15:49:43 +08:00