Skip to content

docs: sync App Toolkit with dify#35442 follow-up settings#754

Closed
RiskeyL wants to merge 4 commits into
mainfrom
docs/followup-questions-config
Closed

docs: sync App Toolkit with dify#35442 follow-up settings#754
RiskeyL wants to merge 4 commits into
mainfrom
docs/followup-questions-config

Conversation

@RiskeyL
Copy link
Copy Markdown
Contributor

@RiskeyL RiskeyL commented Apr 27, 2026

Summary

  • Rewrite the Follow-up section in additional-features.mdx for dify#35442, which makes follow-up question generation configurable per app (model and prompt). Aligns the en/zh/ja UI labels on the same page with the current codebase i18n (e.g., 追问 → 下一步问题建议, テキスト読み上げ → テキストから音声へ, OpenAI Moderation → OpenAI モデレーション).
  • Fix two false positives in the CJK format-check linter: ![alt](url) lines no longer trip the half-width-punct check, and sentences with multiple bolds no longer flag cross-pair adjacency.
  • Broaden the post-writing audit scope. Terminology-check now covers full files (not diffs), collects bolded UI labels plus feature section headings, verifies against codebase i18n as the source of truth, proposes glossary updates when new or renamed labels surface, and excludes env var pages. Format-check-en and format-check-cjk make full-file scope explicit.

Copilot AI review requested due to automatic review settings April 27, 2026 03:02
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 27, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
dify-core-product 🟢 Ready View Preview Apr 27, 2026, 3:05 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Apr 27, 2026
@dosubot dosubot Bot added the documentation Improvements or additions to documentation label Apr 27, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Dify docs and doc-audit tooling to reflect configurable follow-up question generation per app, align translated UI labels with current i18n, and reduce formatting-linter false positives.

Changes:

  • Rewrites the “Follow-up” section in additional-features.mdx across en/zh/ja and aligns several UI labels/wording with current terminology.
  • Improves the CJK format linter to better ignore Markdown image/link syntax and to avoid false positives when multiple bold spans appear on a line.
  • Updates writing/audit guidance and Claude “skill” instructions to make full-file (not diff-only) audits explicit, and broadens terminology-check scope.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
zh/use-dify/build/additional-features.mdx Updates Follow-up/feature labels and related UI wording in Chinese.
ja/use-dify/build/additional-features.mdx Updates Follow-up/feature labels and related UI wording in Japanese; minor spacing fixes around links.
en/use-dify/build/additional-features.mdx Updates Follow-up copy and minor consistency tweaks.
writing-guides/index.md Clarifies that checks audit entire documents, not just diffs.
tools/translate/formatting-zh.md Adjusts Chinese translation formatting guidance (Tab titles rule).
.claude/skills/dify-docs-terminology-check/SKILL.md Expands terminology audit scope and shifts UI-label source-of-truth to codebase i18n.
.claude/skills/dify-docs-format-check-en/SKILL.md Makes English format check explicitly full-file scoped.
.claude/skills/dify-docs-format-check-cjk/SKILL.md Makes CJK format check explicitly full-file scoped.
.claude/skills/dify-docs-format-check-cjk/check-format-cjk.py Fixes CJK linter false positives for images and multi-bold adjacency.
Comments suppressed due to low confidence (1)

.claude/skills/dify-docs-terminology-check/SKILL.md:99

  • This skill still includes a “First-Mention Rule (zh/ja only)” section in the output format, but the “Checks to Perform” section no longer defines or instructs the reader to run that check. Either reintroduce the check instructions (and the rule definition) or remove the output section so the skill is internally consistent.
- ✅ All UI labels (bolded terms and feature section headings) match codebase
  OR
- ⚠️ Line {n}: **{label}** — codebase says "{expected}"

**First-Mention Rule** (zh/ja only)
- ✅ All terms properly introduced
  OR

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tools/translate/formatting-zh.md Outdated
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>
@RiskeyL RiskeyL closed this Apr 27, 2026
RiskeyL added a commit that referenced this pull request Apr 27, 2026
* 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>
@RiskeyL RiskeyL deleted the docs/followup-questions-config branch April 27, 2026 06:58
RiskeyL added a commit that referenced this pull request Apr 29, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants