@aigne/doc-smith 0.8.12-beta.6 → 0.8.12-beta.8

package/docs/overview.zh.md

@@ -1,12 +1,12 @@
 # 概述
 
-AIGNE DocSmith 是一款利用人工智能从项目源代码自动创建文档的工具。它基于 AIGNE 框架构建，旨在生成能够准确反映代码库的结构化、多语言文档。
+AIGNE DocSmith 是一款利用人工智能从项目源代码自动创建文档的工具。它基于 [AIGNE Framework](https://www.aigne.io/framework) 构建，旨在生成能够准确反映代码库的结构化、多语言文档。
 
-DocSmith 的主要目标是解决手动编写文档时面临的常见挑战，例如耗时、代码变更后内容过时以及缺乏一致性。通过自动化此过程，DocSmith 有助于确保您的文档保持最新和准确。
+DocSmith 的主要目标是解决手动编写文档时常见的挑战，例如耗时、代码变更后内容过时以及缺乏一致性。通过自动化此过程，DocSmith 有助于确保您的文档保持最新和准确。
 
 ## 工作原理
 
-DocSmith 通过分析项目的源代码来理解其结构、组件和功能。基于此分析，它会生成一套完整的文档，从高级指南到详细的 API 参考手册。
+DocSmith 通过分析项目的源代码来理解其结构、组件和功能。基于此分析，它会生成一套完整的文档，从高级指南到详细的 API 参考。
 
 ```d2
 direction: down
@@ -17,7 +17,7 @@ Source-Code: {
 }
 
 DocSmith: {
-  label: "AIGNE DocSmith\n（AI 分析引擎）"
+  label: "AIGNE DocSmith\n(AI 分析引擎)"
   shape: rectangle
 }
 
@@ -34,11 +34,11 @@ DocSmith -> Docs: "生成"
 
 DocSmith 提供了一系列功能来处理从创建到发布的整个文档生命周期。
 
-*   **AI 驱动生成**：分析您的代码库，提出逻辑化的文档结构，并生成解释代码功能的内容。
-*   **多语言支持**：可将文档翻译成 12 种语言，包括英语、简体中文和日语。翻译过程具备上下文感知能力，以保持技术准确性。
-*   **与 LLM 集成**：可连接各种大型语言模型（LLM）。默认情况下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，该服务允许您在 Google Gemini 和 OpenAI GPT 等模型之间切换，而无需单独的 API 密钥。您也可以配置自己的 API 密钥以直接访问提供商。
-*   **智能更新**：检测源代码中的变更，并更新文档的相应部分。您还可以提供具体反馈以优化生成的内容。
-*   **发布选项**：通过单个命令即可发布您生成的文档。您可以将其部署到官方 DocSmith 平台，也可以部署到您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 实例。Discuss Kit 是一项用于托管和展示文档的服务。
+*   **AI 驱动的生成**：分析您的代码库以提出逻辑化的文档结构，并生成解释代码功能的内容。
+*   **多语言支持**：可将文档翻译成 12 种语言，包括英语、中文（简体）和日语。翻译过程能够感知上下文，以保持技术准确性。
+*   **与 LLM 集成**：可连接各种大语言模型 (LLM)。默认情况下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，该服务允许您在 Google Gemini 和 OpenAI GPT 等模型之间切换，而无需单独的 API 密钥。您也可以配置自己的 API 密钥以直接访问提供商。
+*   **智能更新**：检测源代码中的更改并更新文档的相应部分。您还可以提供具体反馈以优化生成的内容。
+*   **发布选项**：通过单个命令发布您生成的文档。您可以部署到官方 DocSmith 平台或您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 实例。Discuss Kit 是一项用于托管和展示文档的服务。
 
 ## 可用命令
 
@@ -46,16 +46,16 @@ DocSmith 通过一组命令进行操作。下表总结了主要命令及其功
 
 | 命令 | 描述 |
 | :--- | :--- |
-| `generate` | 从源文件创建一套新的文档。 |
-| `update` | 根据代码变更或新的反馈修改现有文档。 |
-| `translate` | 将文档翻译成 12 种支持的语言中的一种或多种。 |
+| `generate` | 从您的源文件创建一套新的文档。 |
+| `update` | 根据代码更改或新的反馈修改现有文档。 |
+| `translate` | 将文档翻译成 12 种支持语言中的一种或多种。 |
 | `publish` | 将您的文档部署到一个可实时访问的 URL。 |
-| `evaluate` | 评估所生成文档的质量和完整性。 |
-| `history` | 查看文档的更新历史。 |
-| `chat` | 启动一个交互式聊天会话，以协助完成文档任务。 |
+| `evaluate` | 评估您生成的文档的质量和完整性。 |
+| `history` | 查看对您的文档所做的更新历史。 |
+| `chat` | 启动一个交互式聊天会话，以协助处理文档任务。 |
 | `clear` | 删除生成的文件、配置和缓存数据。 |
 | `prefs` | 管理用于文档生成的已保存偏好和配置。 |
 
 ---
 
-本概述简要介绍了 AIGNE DocSmith 的用途和功能。要开始使用该工具，请参阅 [快速入门](./getting-started.md) 指南以获取安装和设置说明。
+本概述对 AIGNE DocSmith 的用途和功能进行了高级总结。要开始使用该工具，请继续阅读 [快速入门](./getting-started.md) 指南以获取安装和设置说明。

package/docs/release-notes.md

@@ -1,6 +1,39 @@
 # Release Notes
 
-This document provides a summary of new features, improvements, and bug fixes for each version of the tool. All changes are listed in reverse chronological order.
+This document provides a chronological record of new features, improvements, and bug fixes for each version of the tool.
+
+## Version 0.8.12-beta.7 (2025-10-12)
+
+### New Features
+
+- The tool can now retrieve context more effectively from the project repository, leading to more accurate documentation.
+
+### Bug Fixes
+
+- Disabled Git-based update history tracking within repositories to prevent potential conflicts.
+
+## Version 0.8.12-beta.6 (2025-10-11)
+
+### Bug Fixes
+
+- Improved the reliability of the publishing process by enhancing login session checks.
+
+## Version 0.8.12-beta.5 (2025-10-11)
+
+### Bug Fixes
+
+- Fixed a bug where the correct language setting was not applied during document checks.
+
+## Version 0.8.12-beta.4 (2025-10-11)
+
+### New Features
+
+- Introduced optimizations for handling large projects, resulting in more efficient document generation.
+
+### Bug Fixes
+
+- Ensured that generated documents follow a strict heading hierarchy (e.g., no skipping from H1 to H3).
+- Improved the clarity of update notifications and added an option to clear deployment configurations.
 
 ## Version 0.8.12-beta.3 (2025-10-09)
 
@@ -12,19 +45,19 @@ This document provides a summary of new features, improvements, and bug fixes fo
 
 ### Bug Fixes
 
-- Corrected an error with file paths when updating documents.
-- Fixed a problem that could cause document generation and updates to fail.
+- Corrected an error with file path resolution when updating documents.
+- Fixed an issue that could cause document generation and updates to fail.
 
 ## Version 0.8.12-beta.1 (2025-10-08)
 
 ### New Features
 
 - Introduced history tracking, allowing you to view past changes to your documents.
-- Translation is now an optional step during the document update process, providing more flexibility.
+- Made translation an optional step during the document update process for greater flexibility.
 
-### Improvements
+### Bug Fixes
 
-- The document generation and update process has been refined for better reliability.
+- Refined the logic for document generation and updates to distinguish between system and user prompts.
 
 ## Version 0.8.12-beta (2025-10-07)
 
@@ -40,8 +73,8 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- Enhanced the document generator and updater for better performance.
-- Improved the speed of document structure analysis and content refinement by using a shared context.
+- Enhanced the document generator and updater with improved file system tools.
+- Implemented a shared context mechanism to speed up document structure analysis and content refinement.
 
 ### Bug Fixes
 
@@ -58,18 +91,18 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- Added a "check-only" option for agents that use selection inputs.
+- Added a "check-only" option for processes that use selection inputs.
 
 ### Bug Fixes
 
 - Improved error handling in the document selection utility.
-- Tuned the translation prompt; comments within code blocks are now translated correctly.
+- Tuned the translation prompt to ensure that only comments within code blocks are translated.
 
 ## Version 0.8.11-beta.3 (2025-09-29)
 
 ### Bug Fixes
 
-- Added a command-line entry for the evaluation agents.
+- Added a command-line interface entry for the document evaluation agents.
 
 ## Version 0.8.11-beta.2 (2025-09-27)
 
@@ -82,12 +115,12 @@ This version includes general maintenance and stability improvements.
 ### New Features
 
 - Introduced a document evaluation feature to generate quality reports.
-- Enhanced the document and structure update process with improved tools.
+- Enhanced the document and structure update process with improved internal tools.
 - Improved vendor handling and debugging capabilities during the publishing process.
 
 ### Bug Fixes
 
-- Fixed an issue where component descriptions were treated as attributes instead of text, improving custom component rendering.
+- Fixed an issue where component descriptions were incorrectly treated as attributes instead of text content, improving custom component rendering.
 
 ## Version 0.8.10 (2025-09-20)
 
@@ -97,14 +130,14 @@ This version includes general maintenance and stability improvements.
 
 ### Bug Fixes
 
-- Added links related to enterprise deployment.
-- Polished the copywriting for the document review prompt.
+- Added relevant links for enterprise deployment.
+- Polished the text for the document review prompt for better clarity.
 
 ## Version 0.8.10-beta.2 (2025-09-18)
 
 ### Bug Fixes
 
-- Improved the prompts and display for the documentation structure review.
+- Improved the prompts and display for the documentation structure review feature.
 - Updated the usage rules for field elements to ensure correct rendering.
 
 ## Version 0.8.10-beta.1 (2025-09-18)
@@ -128,7 +161,7 @@ This version includes general maintenance and stability improvements.
 
 ### Bug Fixes
 
-- Optimized the copy for inquiry feedback to be clearer and more helpful.
+- Optimized the text for inquiry feedback prompts to be clearer and more helpful.
 
 ## Version 0.8.7 (2025-09-12)
 
@@ -140,11 +173,11 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- The URL is now displayed by default after a successful publishing process.
+- The documentation URL is now displayed by default after a successful publishing process.
 
 ### Bug Fixes
 
-- Ensured that logs are saved correctly during the deployment process to prevent data loss.
+- Ensured that logs are saved correctly during deployment to prevent data loss.
 
 ## Version 0.8.5 (2025-09-10)
 
@@ -156,7 +189,7 @@ This version includes general maintenance and stability improvements.
 
 ### Bug Fixes
 
-- Markdown code blocks are now parsed into a custom `<x-code>` element with support for enhanced attributes like titles and icons.
+- Markdown code blocks are now parsed into a custom element with support for enhanced attributes like titles and icons.
 - Made the background for D2 diagrams transparent for better integration with different themes.
 
 ## Version 0.8.3 (2025-09-05)
@@ -169,7 +202,7 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- Tuned the D2 chart generation with more comprehensive examples to improve output quality.
+- Improved D2 chart generation with more comprehensive internal examples to enhance output quality.
 
 ## Version 0.8.0 (2025-09-03)
 
@@ -181,7 +214,7 @@ This version includes general maintenance and stability improvements.
 
 ### Bug Fixes
 
-- Fixed a bug where using the tab key for path selection did not work as expected.
+- Fixed a bug where using the Tab key for path selection did not work as expected.
 
 ## Version 0.7.0 (2025-08-30)
 
@@ -195,7 +228,7 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- Implemented complete support for media processing before publishing documents.
+- Implemented support for media processing before publishing documents.
 
 ## Version 0.5.0 (2025-08-26)
 
@@ -205,7 +238,7 @@ This version includes general maintenance and stability improvements.
 
 ### Bug Fixes
 
-- Polished the text of the questions asked during the initial setup process.
+- Polished the text of questions asked during the initial setup process.
 
 ## Version 0.4.4 (2025-08-22)
 
@@ -229,7 +262,7 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- Polished the workflow for collecting context during document generation.
+- Refined the workflow for collecting context during document generation.
 
 ### Bug Fixes
 
@@ -239,7 +272,7 @@ This version includes general maintenance and stability improvements.
 
 ### Bug Fixes
 
-- Switched the default language model to improve generation quality.
+- Switched the default large language model to improve generation quality.
 
 ## Version 0.2.5 (2025-08-08)
 
@@ -251,5 +284,5 @@ This version includes general maintenance and stability improvements.
 
 ### New Features
 
-- The tool will now automatically initialize the configuration if it's missing when a command is run.
+- The tool will now automatically initialize the configuration if it is missing when a command is run.
 - Added a new `update` command to refresh documents when source files have changed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.12-beta.6",
+  "version": "0.8.12-beta.8",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
@@ -29,6 +29,7 @@
     "fs-extra": "^11.3.1",
     "glob": "^11.0.3",
     "gpt-tokenizer": "^3.2.0",
+    "image-size": "^2.0.2",
     "isbinaryfile": "^5.0.6",
     "jsdom": "^26.1.0",
     "marked": "^15.0.12",

package/prompts/common/afs/afs-tools-usage.md

@@ -0,0 +1,5 @@
+<afs-tool-usage>
+When to use Tools:
+- During document generation, if the given context is missing or lacks referenced content, use afs_list/afs_search/afs_read to obtain more context
+- Code examples in generated documents must use APIs and packages defined in the input data sources. Do not generate non-existent code out of thin air. Use afs_list/afs_search/afs_read to query related code or references
+</afs-tool-usage>

package/prompts/common/afs/use-afs-instruction.md

@@ -0,0 +1 @@
+Use AFS tools to list/search/read files to obtain more context or references. Ensure all content is accurate, relevant, and well-structured.

package/prompts/detail/generate/system-prompt.md

@@ -1,7 +1,6 @@
 <role_and_goal>
 {% include "../../common/document/role-and-personality.md" %}
 
-Your task is to generate detailed document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), DataSources, documentStructure (overall structural planning), and other relevant information.
 </role_and_goal>
 
 
@@ -50,18 +49,6 @@ Diagram generation rules:
 </content_generation_rules>
 
 
-<tool-usage>
-1. glob: Find files matching specific patterns with advanced filtering and sorting.
-
-2. grep: Search file contents using regular expressions with multiple strategies (git grep → system grep → JavaScript fallback).
-
-3. readFile: Read file contents with intelligent binary detection, pagination, and metadata extraction.
-
-When to use Tools:
-- During document generation, if the given context is missing or lacks referenced content, use glob/grep/readFile to obtain more context
-- Code examples in generated documents must use APIs and packages defined in the input data sources. Do not generate non-existent code out of thin air. Use glob/grep/readFile to query related code or references
-</tool-usage>
-
 
 <output_constraints>
 

package/prompts/detail/generate/user-prompt.md

@@ -52,3 +52,10 @@ User feedback on previous generation:
 {{feedback}}
 </feedback>
 {% endif %}
+
+{% include "../../common/afs/afs-tools-usage.md" %}
+
+<instructions>
+Generate detailed document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), DataSources, documentStructure (overall structural planning), and other relevant information.
+{% include "../../common/afs/use-afs-instruction.md" %}
+</instructions>

package/prompts/detail/update/system-prompt.md

@@ -1,7 +1,5 @@
 <role_and_goal>
 {% include "../../common/document/role-and-personality.md" %}
-
-Your task is to analyze the original document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
 </role_and_goal>
 
 
@@ -108,6 +106,7 @@ Error handling:
 
 {% include "../generate/detail-example.md" %}
 
+
 <output_format>
 ** Only output operation execution status **:
 - Only return 'success' if operation executed successfully

package/prompts/detail/update/user-prompt.md

@@ -31,3 +31,10 @@
 <user_feedback>
 {{feedback}}
 </user_feedback>
+
+{% include "../../common/afs/afs-tools-usage.md" %}
+
+<instructions>
+Analyze the original document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
+{% include "../../common/afs/use-afs-instruction.md" %}
+</instructions>

package/prompts/evaluate/document-structure.md

@@ -31,16 +31,16 @@ You must **precisely map** the correspondence between each module in the structu
 Start from a **baseline of 80 points**. Evaluate by logging every key observation in `details` with one of five **levels**. Each level contributes a fixed delta; sum all deltas and add them to the baseline (clamp the final score to 0–100). Treat every key point independently so strengths and gaps can stack.
 
 **Level catalog (use consistently across all dimensions):**
-- `Excellent` — Exceptional: fully satisfies the dimension with clear, actionable outputs; scoring +10.
-- `Good` — Strong: aligns well with the dimension with only minor gaps apply +2 points; scoring +2.
-- `Meets` — Adequate: acceptable baseline coverage without notable strengths or weaknesses; scoring +0.
-- `Minor` — Problematic: specific deficiencies that reduce usefulness and require fixes; scoring -2.
-- `Critical` — Failing: fundamental issues that prevent the dimension from being met; scoring -10.
+- `Excellent` — Exceptional: fully satisfies the dimension with clear, actionable outputs.
+- `Good` — Strong: aligns well with the dimension with only minor gaps.
+- `Meets` — Adequate: acceptable baseline coverage without notable strengths or weaknesses.
+- `Minor` — Problematic: specific deficiencies that reduce usefulness and require fixes.
+- `Critical` — Failing: fundamental issues that prevent the dimension from being met.
 
 Apply these levels to the following key points. Create a separate detail entry for each observation; if the same issue repeats (e.g., multiple typos), record multiple entries at the appropriate level.
 
 1. **Purpose Coverage** — Evaluate every selected purpose, paying special attention to declared priorities:
-  - `Excellent`: The structure provides dedicated modules, explicit workflows, and measurable steps that achieve the purpose end-to-end scoring +10.
+  - `Excellent`: The structure provides dedicated modules, explicit workflows, and measurable steps that achieve the purpose end-to-end.
   - `Good`: The purpose is clearly mapped to modules with practical guidance and minimal omissions.
   - `Meets`: The purpose appears in general sections or implicit references but lacks targeted treatment.
   - `Minor`: Important sub-tasks or ordering for the purpose are missing or incomplete, reducing utility.
@@ -82,7 +82,6 @@ Strictly follow these steps:
 
 <output_constraints>
 
-- `baseline` must be fixed at 80
 - `details` is an array. Each element must include:
   - `dimension`: one of `purposeCoverage`, `audienceCoverage`, `coverageDepth`
   - `level`: one of `excellent`, `good`, `meets`, `minor`, `critical`

package/prompts/evaluate/document.md

@@ -48,73 +48,66 @@ Please **strictly adhere** to the evaluation standards defined in `<standards>`
 
 <standards>
 
-Start from a **baseline of 80 points**. Evaluate by logging every key observation in `details` using one of five **levels**. Each level corresponds to a fixed score delta: +10, +2, 0, -2, -10 respectively. Sum deltas with the baseline and clamp the final score to 0–100. Treat each key point independently so strengths and gaps can stack. When the same issue recurs (e.g., multiple typos), create multiple entries.
+Start from a **baseline of 80 points**. Evaluate by logging every key observation in `details` using one of five **levels**. Each level corresponds to a fixed score delta. Sum deltas with the baseline and clamp the final score to 0–100. Treat each key point independently so strengths and gaps can stack. When the same issue recurs (e.g., multiple typos), create multiple entries.
 
 **Level catalog (use consistently across all dimensions):**
-- `Excellent` — Exceptional output that fully satisfies the dimension with clear, actionable results; scoring +10.
-- `Good` — Strong and mostly complete alignment with the dimension; minor gaps only; scoring +2.
-- `Meets` — Satisfactory baseline coverage without significant strengths or faults; scoring +0.
-- `Minor` — Specific problems that reduce usefulness and should be corrected; scoring -2.
-- `Critical` — Fundamental failures that prevent the dimension from being met; scoring -10.
+- `Excellent` — Exceptional output that fully satisfies the dimension with clear, actionable results.
+- `Good` — Strong and mostly complete alignment with the dimension; minor gaps only.
+- `Meets` — Satisfactory baseline coverage without significant strengths or faults.
+- `Minor` — Specific problems that reduce usefulness and should be corrected.
+- `Critical` — Fundamental failures that prevent the dimension from being met.
 
 Apply these levels to the following evaluation dimensions:
 
-1. **Readability** — Language clarity, grammar, spelling, and fluency.
+1. **Readability** — Language clarity, grammar, spelling, and fluency. **MUST evaluate on every document**
    - `Excellent`: Text is polished, natural, and easy to read; terminology is well chosen and consistent.
    - `Good`: Minor slips (occasional typos or awkward phrasing) that do not impede understanding.
    - `Meets`: Understandable but plain or mechanical; no major errors.
    - `Minor`: Noticeable grammar or spelling mistakes in specific sentences that need fixes.
    - `Critical`: Language prevents comprehension or is unusable.
 
-2. **Coherence** — Logical flow, transitions, and absence of contradictions.
+2. **Coherence** — Logical flow, transitions, and absence of contradictions. **MUST evaluate on every document**
    - `Excellent`: Clear, well-ordered flow with explicit transitions and consistent argumentation.
    - `Good`: Mostly coherent with small gaps in transitions or sequencing.
    - `Meets`: Functional flow but requires reader inference to connect ideas.
    - `Minor`: Local ordering problems or small contradictions that confuse the reader.
    - `Critical`: Structural contradictions or ordering failures that break the document's logic.
 
-3. **Content Quality** — Coverage, accuracy, examples, and actionable detail relative to the plan (`description`).
+3. **Content Quality** — Coverage, accuracy, examples, and actionable detail relative to the plan (`description`). **MUST evaluate on every document**
    - `Excellent`: Content fully implements the plan with accurate, actionable guidance and relevant examples.
    - `Good`: Most planned items are addressed with only minor missing details.
    - `Meets`: Baseline coverage is present but lacks depth or practical instructions.
    - `Minor`: Certain sections are missing, incorrect, or ambiguous and should be corrected.
    - `Critical`: Core content is wrong or absent, failing to deliver planned outcomes.
 
-4. **Consistency** — Terminology, style, formatting, and references.
+4. **Consistency** — Terminology, style, formatting, and references. **MUST evaluate on every document**
    - `Excellent`: Terms, style, and formatting are uniform and purposeful across the document.
    - `Good`: Largely consistent with only isolated mismatches that do not impede understanding.
    - `Meets`: Acceptable uniformity but lacks deliberate stylistic cohesion.
    - `Minor`: Specific term or formatting inconsistencies that should be standardized.
    - `Critical`: Pervasive inconsistency that undermines trust in the content.
 
-5. **Purpose Alignment** — Relevance to user-selected purposes (document only needs to satisfy at least one when multiples exist).
-   - `Excellent`: The document supplies targeted sections, validation steps, and clear calls-to-action that realize the chosen purpose scoring +10.
+5. **Purpose Alignment** — Relevance to user-selected purposes (document only needs to satisfy at least one when multiples exist). (Conditional Rule Application: When evaluating this document, first determine if its content (topic, type, format, etc.) is highly relevant to the scope of this evaluation rule. Apply this specific criterion only if the content is deemed relevant.)
+   - `Excellent`: The document supplies targeted sections, validation steps, and clear calls-to-action that realize the chosen purpose.
    - `Good`: Purpose is clearly addressed but may lack polish or some validation details.
    - `Meets`: Purpose is present in general terms but lacks concrete steps or targeted content.
    - `Minor`: Key components required by the purpose are missing or incomplete.
    - `Critical`: Document fails to address the selected purpose or pursues a different objective.
 
-6. **Audience Alignment** — Tone, assumptions, and artifacts for target persona(s).
+6. **Audience Alignment** — Tone, assumptions, and artifacts for target persona(s). (Conditional Rule Application: When evaluating this document, first determine if its content (topic, type, format, etc.) is highly relevant to the scope of this evaluation rule. Apply this specific criterion only if the content is deemed relevant.)
    - `Excellent`: Messaging, examples, and precautions are tailored to each audience persona and their needs.
    - `Good`: Tone and examples suit the audience with only minor mismatches.
    - `Meets`: Document is generally usable by audiences but lacks persona-specific guidance.
    - `Minor`: Sections explicitly mismatch audience skill levels or expectations and should be revised.
    - `Critical`: Document is pitched at the wrong audience and cannot be used meaningfully.
 
-7. **Knowledge Level Alignment** — Depth versus reader expertise.
+7. **Knowledge Level Alignment** — Depth versus reader expertise. (Conditional Rule Application: When evaluating this document, first determine if its content (topic, type, format, etc.) is highly relevant to the scope of this evaluation rule. Apply this specific criterion only if the content is deemed relevant.)
    - `Excellent`: Material offers layered explanations, optional deep dives, and matches expected expertise.
    - `Good`: Overall depth fits the reader with small areas that are slightly over- or under-advanced.
-   - `Meets`: Baseline depth is acceptable but uneven across topics scoring 0.
+   - `Meets`: Baseline depth is acceptable but uneven across topics.
    - `Minor`: Specific sections are noticeably too shallow or too advanced and need rework.
    - `Critical`: The document's level is consistently misaligned with reader expertise.
 
-8. **Navigability** — Link accuracy, anchor availability, and cross-reference integrity.
-   - `Excellent`: TOC, anchors, and cross-links are accurate and make navigation effortless.
-   - `Good`: Navigation and links are mostly correct with minor issues scoring +2.
-   - `Meets`: Basic navigation exists but lacks robust anchors or enhancements.
-   - `Minor`: Some broken or mismatched links and missing anchors that should be fixed.
-   - `Critical`: Multiple broken links or mislabeled sections make navigation unreliable.
-
 </standards>
 
 <rules>
@@ -136,10 +129,8 @@ Strictly follow these steps:
 </rules>
 
 <output_constraints>
-
-- `baseline` must be fixed at 80
 - `details` is an array. Each element must include:
-  - `dimension`: one of `readability`, `coherence`, `contentQuality`, `consistency`, `purposeAlignment`, `audienceAlignment`, `knowledgeLevelAlignment`, `navigability`
+  - `dimension`: one of `readability`, `coherence`, `contentQuality`, `consistency`, `purposeAlignment`, `audienceAlignment`, `knowledgeLevelAlignment`
   - `level`: one of `excellent`, `good`, `meets`, `minor`, `critical`
   - `topic`: short identifier for the passage/section being judged
   - `line`: integer line number within the source document (use 0 if unknown)

package/prompts/media/media-description/system-prompt.md

@@ -0,0 +1,35 @@
+<role_and_goal>
+You are an expert at analyzing media files (images and videos) and generating concise, meaningful descriptions for documentation content.
+
+Your goal is to examine a single media file and generate an accurate description that helps both AI content generators and human readers understand what the media depicts and how it can be used effectively in documentation.
+</role_and_goal>
+
+<analysis_workflow>
+1. **Analyze**: Examine the media file carefully and identify:
+   - The main subject or component being shown
+   - Key visual elements (colors, composition, style)
+   - Notable features or functionality visible
+   - The purpose or context of this media
+   - Mood or atmosphere if distinctive
+   - For videos: key actions, movements, or transitions
+
+2. **Generate Description**: Create a concise, human-readable description following these principles:
+   - Keep it between 2-3 sentences
+   - Be specific and descriptive about visual content
+   - For videos, describe the key content or action shown
+   - Focus on aspects that matter for documentation usage
+   - Remain objective - describe what you see, not what you interpret
+</analysis_workflow>
+
+<description_guidelines>
+**What to Include:**
+- Main subject or focus of the media
+- Key visual elements and composition
+- Context or setting if relevant for understanding
+- Technical aspects if relevant (e.g., "screenshot", "diagram", "illustration", "animation")
+- Key features or functionality visible
+- Its purpose or functionality
+- Any notable UI elements or features
+- For videos: describe the main action, movement, or narrative
+</description_guidelines>
+

package/prompts/media/media-description/user-prompt.md

@@ -0,0 +1,8 @@
+<media_information>
+- File: {{name}}
+- Type: {{type}}
+{%if width and height %}
+- Dimensions: {{width}}x{{height}}px
+{%endif%}
+</media_information>
+

package/prompts/structure/generate/system-prompt.md

@@ -1,25 +1,6 @@
 <role_and_goal>
 You are an AI document strategist with the personality of an **INTJ (The Architect)**. Your core strengths are strategic thinking, understanding complex systems, and creating logically sound blueprints. You are a perfectionist, rigorously logical, and can anticipate future challenges.
 
-
-Your task is to design a detailed structural plan for the document to be generated. This plan will serve as a "blueprint" for subsequent content generation, guiding the LLM on how to organize and present information, ensuring the document is logically clear, easy to understand, well-structured, and comprehensive.
-
-Key capabilities and behavioral principles:
-  - Data Comprehension: Ability to parse and understand structured and unstructured data, identifying key concepts, entities, attributes, relationships, and processes within them.
-  - Structured Thinking: Strong logical analysis capabilities to decompose complex information into clear chapters, sections, and items, establishing reasonable hierarchical relationships.
-  - User-Oriented Approach: Ability to flexibly adjust the focus and level of detail in structural planning based on document objectives and audience characteristics provided by users.
-  - Modular Design: Tendency to divide documents into independent, reusable modules or sections for easy content population and subsequent maintenance.
-  - Flexibility and Adaptability: Ability to handle multiple types of data sources and design the most suitable documentation structure based on data source characteristics (such as code function/class structures, API endpoints/parameters, text paragraphs/themes).
-  - Clarity and Completeness: Ensure the final structural plan is easy to understand and can guide the LLM to generate a comprehensive and well-organized document.
-
-
-Objectives:
-  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
-  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
-
-{% include "../../common/document-structure/intj-traits.md" %}
-
-Always follow one principle: You must ensure the final structural plan meets user requirements.
 </role_and_goal>
 
 

package/prompts/structure/generate/user-prompt.md

@@ -60,4 +60,25 @@ Sub-structures must meet the following requirements:
 - Further break down and comprehensively display the content planned in the parent document
 - All sub-structures must have their parentId value set to {{parentDocument.path}}
 </parent_document>
-{% endif %}
+{% endif %}
+
+<instructions>
+Your task is to design a detailed structural plan for the document to be generated. This plan will serve as a "blueprint" for subsequent content generation, guiding the LLM on how to organize and present information, ensuring the document is logically clear, easy to understand, well-structured, and comprehensive.
+
+Key capabilities and behavioral principles:
+  - Data Comprehension: Ability to parse and understand structured and unstructured data, identifying key concepts, entities, attributes, relationships, and processes within them.
+  - Structured Thinking: Strong logical analysis capabilities to decompose complex information into clear chapters, sections, and items, establishing reasonable hierarchical relationships.
+  - User-Oriented Approach: Ability to flexibly adjust the focus and level of detail in structural planning based on document objectives and audience characteristics provided by users.
+  - Modular Design: Tendency to divide documents into independent, reusable modules or sections for easy content population and subsequent maintenance.
+  - Flexibility and Adaptability: Ability to handle multiple types of data sources and design the most suitable documentation structure based on data source characteristics (such as code function/class structures, API endpoints/parameters, text paragraphs/themes).
+  - Clarity and Completeness: Ensure the final structural plan is easy to understand and can guide the LLM to generate a comprehensive and well-organized document.
+
+
+Objectives:
+  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
+  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
+
+{% include "../../common/document-structure/intj-traits.md" %}
+
+Always follow one principle: You must ensure the final structural plan meets user requirements.
+</instructions>

package/prompts/structure/update/system-prompt.md

@@ -6,23 +6,6 @@ Your task is to understand user requirements and execute the appropriate structu
 
 {% include "../../common/document-structure/intj-traits.md" %}
 
-Processing workflow:
-
-- If user feedback is not in English, translate it to English first to better understand user intent
-- Analyze user feedback to understand the specific intent (add, delete, update, or move sections)
-- Determine which tools to use based on the user's requirements
-- Execute the appropriate operations using available tools
-- Ensure all modifications maintain documentation structure integrity
-- Return 'success' when the latest version of websiteStructure meets user feedback
-
-Rules:
-** All changes must be made using Tools. **
-** Carefully check if the latest version of documentStructure data meets user requirements, must avoid duplicate Tool calls. **
-
-Objectives:
-  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
-  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
-
 </role_and_goal>