Commit Graph

12 Commits

Author SHA1 Message Date
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 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
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
Riskey 5c1c3a4cc9 docs: sync documentation for Dify v1.13.0–v1.13.3 changes (#722)
* feat: optimize the docs-release-sync skill

* docs: add doc_form validation to knowledge API spec

* docs: update AI Credits/Default Model Settings terminology
2026-03-30 22:16:46 +08:00
Riskey 21122c4282 Batch update apis (#715)
* Batch update service apis

* final check and add zh/ja docs

* add temporary redirects for changed api links embedded in the product

* Restore original operationIds to preserve SDK compatibility

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

* complete the missing descriptions

* correct the human input terminology

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-23 16:38:10 +08:00
FFXN df83a9a07c feat: summary index for knowledge. (#670)
* feat: summary index for knowledge.

* feat: summary index for knowledge.

* align terminology

* add zh and ja translation

---------

Co-authored-by: Riskey <riskey47@dify.ai>
2026-02-03 22:02:28 +08:00
Jyong fecc1138d5 fix(api): fix en/api-reference/openapi_knowledge.json (#657)
* fix(api): change reranking_mode to reranking_model in openapi_knowledge.json

* add reranking mode field

* update reranking mode description;  standardize rerank model terminology

---------

Co-authored-by: Zhiqiang Yang <58433399+yangzq50@users.noreply.github.com>
Co-authored-by: Riskey <riskey47@dify.ai>
2026-01-08 14:09:50 +08:00
quicksand 9e278d65bf Update partial_member_list schema to require user_id objects across OpenAPI docs (#623) 2025-12-19 10:43:22 +08:00
Riskey f258cdffcb correct the method type for the api that queries tags bound to a dataset (#614)
Co-authored-by: Riskey <riskey47@dify.ai>
2025-12-12 17:42:34 +08:00
Chenhe Gu 767397a9de changed language codes: cn -> zh, jp -> ja. with other supporting structural changes (#565)
* fix redirect language code prefixes

* rename: cn -> zh, jp -> ja

* remove hardcoded ja / zh references

* remove hardcoded 'english' references

* renamed variable names and dict keys to language agnostic names

* fix: add missing language helper methods to PRAnalyzer

- Add get_language_directory() method
- Initialize source_language and target_languages from config
- Fixes AttributeError when generating mixed PR errors

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* test: kitchen sink workflow validation v2

This PR validates the translation workflow after config-driven refactoring:

Changes:
- Add new test file: test-workflow-validation.mdx
- Modify existing file: introduction.mdx
- Update docs.json navigation

Tests:
- New file translation (add workflow)
- Existing file translation (update workflow)
- Navigation sync across languages
- Config-driven language codes (zh/ja instead of cn/jp)
- Source language abstraction (no hardcoded "English")

Expected workflow behavior:
1. Detect changes in en/ directory
2. Translate new file to zh and ja
3. Update modified file translations
4. Sync docs.json for all language sections
5. Commit translated files automatically

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: update workflow paths to use zh/ja instead of cn/jp

Aligns workflow trigger paths with the zh/ja language directory rename.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Revert "fix: update workflow paths to use zh/ja instead of cn/jp"

This reverts commit 9587b7cc5d.

* Revert "test: kitchen sink workflow validation v2"

This reverts commit 4abdd69fd2.

* fix: update workflow paths in doc analyze workflow to use zh/ja instead of cn/jp

* Refactor/language codes (#240)

* test: kitchen sink workflow validation v2

This PR validates the translation workflow after config-driven refactoring:

Changes:
- Add new test file: test-workflow-validation.mdx
- Modify existing file: introduction.mdx
- Update docs.json navigation

Tests:
- New file translation (add workflow)
- Existing file translation (update workflow)
- Navigation sync across languages
- Config-driven language codes (zh/ja instead of cn/jp)
- Source language abstraction (no hardcoded "English")

Expected workflow behavior:
1. Detect changes in en/ directory
2. Translate new file to zh and ja
3. Update modified file translations
4. Sync docs.json for all language sections
5. Commit translated files automatically

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: update workflow paths to use zh/ja instead of cn/jp

Aligns workflow trigger paths with the zh/ja language directory rename.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Revert "fix: update workflow paths to use zh/ja instead of cn/jp"

This reverts commit 9587b7cc5d.

* Revert "test: kitchen sink workflow validation v2"

This reverts commit 4abdd69fd2.

* fix: update workflow paths in doc analyze workflow to use zh/ja instead of cn/jp

---------

Co-authored-by: Claude <noreply@anthropic.com>

* fix: update workflow files to use 'source' instead of 'english'

After refactoring the PR analyzer to use 'source' for source language
PRs (instead of hardcoded 'english'), the workflow files need to match.

Changes:
- sync_docs_analyze.yml: pr_type == 'source' (was 'english')
- sync_docs_update.yml: PR_TYPE != 'source' check
- Updated all comments from "English" to "source language"
- Updated all pr_type values in JSON from "english" to "source"

This ensures the workflows trigger correctly with the refactored
config-driven language system.

Related: language code refactoring (cn/jp → zh/ja)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Fix/workflow source language references (#245)

* test: kitchen sink workflow validation v2

This PR validates the translation workflow after config-driven refactoring:

Changes:
- Add new test file: test-workflow-validation.mdx
- Modify existing file: introduction.mdx
- Update docs.json navigation

Tests:
- New file translation (add workflow)
- Existing file translation (update workflow)
- Navigation sync across languages
- Config-driven language codes (zh/ja instead of cn/jp)
- Source language abstraction (no hardcoded "English")

Expected workflow behavior:
1. Detect changes in en/ directory
2. Translate new file to zh and ja
3. Update modified file translations
4. Sync docs.json for all language sections
5. Commit translated files automatically

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: update workflow paths to use zh/ja instead of cn/jp

Aligns workflow trigger paths with the zh/ja language directory rename.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Revert "fix: update workflow paths to use zh/ja instead of cn/jp"

This reverts commit 9587b7cc5d.

* Revert "test: kitchen sink workflow validation v2"

This reverts commit 4abdd69fd2.

* fix: update workflow paths in doc analyze workflow to use zh/ja instead of cn/jp

* fix: update workflow files to use 'source' instead of 'english'

After refactoring the PR analyzer to use 'source' for source language
PRs (instead of hardcoded 'english'), the workflow files need to match.

Changes:
- sync_docs_analyze.yml: pr_type == 'source' (was 'english')
- sync_docs_update.yml: PR_TYPE != 'source' check
- Updated all comments from "English" to "source language"
- Updated all pr_type values in JSON from "english" to "source"

This ensures the workflows trigger correctly with the refactored
config-driven language system.

Related: language code refactoring (cn/jp → zh/ja)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>

* fix

* fix docs.json language codes

* rename previous version docs: cn -> zh, jp -> ja

* rm duplicate redirect entires

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-11-28 04:00:02 -08:00