mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-07-25 13:35:29 -04:00
docs/app-runner
5 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 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> |
||
|
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 |
||
|
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 |
||
|
Riskey
|
df19776bb0 |
Add workflow 101 tutorial (#705)
* add the zh and en workflow 101 tutorials * refine the formats for readability * refine formatting and minor issues * Update Workflow 101 lessons and images * Update image display in Workflow 101 lesson 01 * Rename Dify workflow image * Update Workflow 101 Lesson 3 with new images and prompt example * Update Workflow 101 Lesson 03 images * Update Dify workflow lesson 4 prompt image * Update Workflow 101 Lesson 5 with new images and content * Update Workflow 101 Lesson 6 content and images * Update Workflow 101 Lesson 08 and add new images * Refine email reply instruction in Workflow 101 lesson 8 * Update Workflow 101 Lesson 9 with new steps and images * Update Workflow 101 Lesson 09 content and images * Fix whitespace in Workflow 101 Lesson 9 * Add image alt text to workflow example in zh lesson 01 * Update LLM node images and text formatting in Workflow 101 Lesson 03 * Update zh/use-dify/tutorials/workflow-101/lesson-05.mdx content * Update zh/workflow-101/lesson-03.mdx for clarity * Remove unnecessary italics in Workflow 101 lesson 4 * Update Workflow 101 Lesson 5 for clarity and image display * Update images in Workflow 101 Lesson 06 * Update Lesson 7 workflow tutorial with new images and text fixes * Update zh/use-dify/tutorials/workflow-101/lesson-06.mdx content * Update prompt instructions in Workflow 101 Lesson 06 * Clarify condition in Workflow 101 Lesson 07 * Fix formatting in Workflow 101 lesson 8 * Update Workflow 101 Lesson 9 for email formatting optimization * Fix typo in Workflow 101 Lesson 9 * Remove Jinja2 example from workflow lesson * Update image syntax in Workflow 101 Lesson 02 * Update image tag in Workflow 101 Lesson 3 * Remove italics from workflow 101 lessons * Fix typo in zh/use-dify/tutorials/workflow-101/lesson-05.mdx * Refine parameter types explanation in Workflow 101 lesson 6 * Refine Chinese text in Workflow 101 lesson 06 * Update Lesson 7: Enhance Workflows content * Fix formatting in Workflow 101 Lesson 7 * Refine Chinese text in Workflow 101 lesson 8 * Refine instructions for Workflow 101 Lesson 08 test run * Clarify the purpose of template conversion in Workflow 101 lesson 9 * Update Workflow 101 Lesson 10 image syntax * Polish workflow 101 tutorials (en/zh) and add ja translation * Update Workflow 101 lesson 1 content * Fix formatting and update workflow creation instructions in Lesson 02 * Clarify multi-modal model description in Workflow 101 lesson 3 * Remove italics from workflow tutorial lessons * Update Workflow 101 Lesson 6 prompt example * Update formatting in Workflow 101 lesson 8 * Update Workflow 101 lesson 1 content * Update zh/use-dify/tutorials/workflow-101/lesson-02.mdx content * Refine Chinese text in Workflow 101 Lesson 3 * Refine RAG explanation in Workflow 101 Lesson 04 * Update zh/use-dify/tutorials/workflow-101/lesson-05.mdx content * Update formatting in Workflow 101 Lesson 08 * final checks * format and terminology fixes --------- Co-authored-by: Anne <annezj92@gmail.com> |
||
|
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 |