docs: record the web app standard and new terms in the glossary - #904
Open
RiskeyL wants to merge 3 commits into
Open
docs: record the web app standard and new terms in the glossary#904RiskeyL wants to merge 3 commits into
RiskeyL wants to merge 3 commits into
Conversation
Standardize on web app / Web 应用 / Web アプリ, lowercase in English body text, and say explicitly that naming a UI element takes the on-screen label verbatim instead. Correct two stale rows: AI Credits pointed at a dead i18n key, and the Max Iterations ja column matched neither the node nor the app setting. Add the Branding and Custom Frontend entry points, the web app access levels and tabs, and the New Agent roster labels.
dosubot
Bot
added
size:M
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Dify’s internal documentation glossary and guide-writing skill to standardize “web app” terminology and to record newly observed product UI labels (including access control levels, publish-panel entries, and new Agent-related strings) so writers/translators can stay consistent with the product interface.
Changes:
- Replaces the legacy “WebApp” glossary term with “web app” (lowercase in English body text) and updates dependent wording (e.g., “end user” definition).
- Corrects stale glossary rows (e.g., Max Iterations JA label and the AI Credits i18n key) and adds multiple new UI-label rows for publish/access/interface and Agent surfaces.
- Updates the guides skill example wording from “trigger plugins” to “trigger integrations” for consistency with current terminology.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| writing-guides/glossary.md | Standardizes “web app” terminology; fixes and extends UI label glossary rows, including access control/interface and Agent labels. |
| .claude/skills/dify-docs-guides/SKILL.md | Adjusts a terminology example to use “trigger integrations” instead of “trigger plugins”. |
Comments suppressed due to low confidence (1)
writing-guides/glossary.md:217
- In the UI Labels section you note that the UI renders this label lowercase ("AI credits"), but the English (UI) column is still capitalized as "AI Credits". Since this table is meant to match on-screen labels verbatim, the English label should be updated to match the stated casing (or the note should be revised if the UI is actually title-cased).
| AI Credits | AI 消息额度 | AI クレジット | common.modelProvider.card.aiCreditsOption | Renamed from "Message Credits" in v1.13.1. UI localizes the label (zh 消息额度, ja クレジット) and renders it lowercase, "AI credits". |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The UI Labels tables quote on-screen text verbatim, so the English column takes the lowercase the product renders. Align the two adjacent notes that referred to the old casing, and point the web app cross-reference at the UI Labels section, which is what the heading is actually called.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
writing-guides/glossary.md:217
- The note references the section-header i18n key as
modelProvider.quotaLabel, but all other keys in this table use their full namespace (e.g.,common.modelProvider.*). Using a shortened/unnamespaced key here makes it harder to grep and can be ambiguous if multiple namespaces contain the same suffix. Consider updating the note to use the fully qualified key name (or explicitly call out the namespace).
| AI credits | AI 消息额度 | AI クレジット | common.modelProvider.card.aiCreditsOption | Renamed from "Message Credits" in v1.13.1. Lowercase c, as the UI renders it; the section header is the all-caps `modelProvider.quotaLabel`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
web app / Web 应用 / Web アプリ, lowercase in English body text, with the rule stated explicitly: naming a UI element takes the on-screen label verbatim instead. The product UI is split across web app, Web App and WebApp in every language, so there is no UI spelling to follow and the glossary has to carry the decision.
Two stale rows corrected. AI Credits pointed at
common.modelProvider.quota, which no longer exists; it is nowcard.aiCreditsOption, and the UI renders the label lowercase. The Max Iterations ja column said 最大イテレーション数, matching neither the workflow node (最大反復回数) nor the classic Agent app setting.New rows: the Branding and Custom Frontend publish-panel entry points, the four web app access levels, the Run Batch / Saved / More like this interface labels, and the New Agent roster labels (Agent task, Edit in Agent Console, Make a copy, New output).
The guides skill picks up the Integration Trigger wording in its example.
No backport labels:
writing-guides/and.claude/are both in.mintignore, so neither reaches readers and release branches gain nothing.Closes DC-78 — the Beta framing is confirmed correct against the product (the Agents nav does carry a BETA chip), and there is no Branding rename to make because the docs never named that entry point. Advances DC-132; its content fixes are in the main cleanup PR.
One gap worth noting in PR D: I could not find an i18n key anywhere in web/i18n/ for the "Agents" nav label, so that one row is absent from the New Agent set.