Commit Graph

13 Commits

Author SHA1 Message Date
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
2026-07-02 19:51:55 +08:00
RiskeyL f5e73aa5b2 feat: add a global contributing footer via custom JS
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>
2026-06-24 11:44:09 +08:00
RiskeyL 6a21cc69ac translate: sync develop-plugin Chinese and Japanese to current English
Bring the develop-plugin zh and ja pages in line with the current English. Around half the pages had been translated from a much older structure and were fully re-translated; the rest received the PR #817 readability polish.

Also normalize section metadata: set the language field per file (zh/ja), render "Dify Marketplace" as the product's own term (Dify 市场 / Dify マーケットプレイス), drop a stale todo field from the FAQ, and repoint four cross-page anchors to the current translated headings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-17 10:53:41 +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 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 40737579af chore: restore docs.json navigation 2026-06-05 18:53:12 +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 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
2026-04-29 21:47:53 +08:00
Luyu Zhang 27bf0c67c1 chore(ci): migrate runners to depot 2026-04-26 11:28:45 -07: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 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 7839e094ff fix: fix broken links and add link-checking workflow (#729)
* 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
2026-04-03 19:07:51 +08:00
Chenhe Gu f1f025b75d consolidate plugin dev docs into main structure (#581)
* move files & renames

* rename files and doc entries

* sync develop plugin files

* update group label translations

* some cleanups

* update configs

* update links

* add remote debug doc

* delete redundant slashes and unnecessary notes

* update ja and zh links

---------

Co-authored-by: Riskey <riskey47@dify.ai>
2025-12-04 16:28:47 +08:00