@aigne/doc-smith 0.0.1 → 0.0.2

package/.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          release-type: node
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          fetch-depth: 2
+
+      - uses: pnpm/action-setup@v3
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          version: 10
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          node-version: 23
+          cache: pnpm
+
+      - name: Install dependencies
+        run: |
+          pnpm install
+        if: ${{ steps.release.outputs.release_created }}
+
+      - name: Publish to NPM
+        if: ${{ steps.release.outputs.release_created }}
+        run: |
+          npm config set '//registry.npmjs.org/:_authToken' "${{ secrets.NPM_TOKEN }}"
+          pnpm publish --access public --no-git-checks

package/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## 0.0.2 (2025-07-30)
+
+
+### Features
+
+* add auto create board ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
+* add docs-mcp ([a7508a1](https://github.com/AIGNE-io/aigne-doc-smith/commit/a7508a13abb2222968b1bc9c14948427af509f97))
+* add input generator agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
+* add publish docs ([41bb126](https://github.com/AIGNE-io/aigne-doc-smith/commit/41bb126caeb1c3c242c7a2be27abb114aeab9953))
+* add support docs labels ([4522c07](https://github.com/AIGNE-io/aigne-doc-smith/commit/4522c07b1ceb05664a1f5b5fb4df06feee536eba))
+* detail add review ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
+* init commit ([dafc40e](https://github.com/AIGNE-io/aigne-doc-smith/commit/dafc40e94f3c407e50b2c46ecb46237f23a15cf7))
+* structure plan add review ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
+
+
+### Bug Fixes
+
+* polish agent name ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
+* polish agent param and description ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
+* polish code ([34f9a24](https://github.com/AIGNE-io/aigne-doc-smith/commit/34f9a24fc3748b4177cad2b5330fe6b3ccd99175))
+* polish code ([0343486](https://github.com/AIGNE-io/aigne-doc-smith/commit/0343486aa086bbe2ced8de849de6a4a42567719c))
+* polish code ([7b7dfb9](https://github.com/AIGNE-io/aigne-doc-smith/commit/7b7dfb925b3aa55956ef7a99ededc749fb6a42d7))
+* polish code ([4fa4694](https://github.com/AIGNE-io/aigne-doc-smith/commit/4fa4694dbbd5880d501883a7cf3c0d3494509fb4))
+* polish code ([74fee51](https://github.com/AIGNE-io/aigne-doc-smith/commit/74fee51ad6337af8811a35f2a4334b67ec109439))
+* polish code ([7fa1675](https://github.com/AIGNE-io/aigne-doc-smith/commit/7fa1675b2cab6144d1fb9d4388130209c6cfa0bc))
+* polish docs review ([70374ab](https://github.com/AIGNE-io/aigne-doc-smith/commit/70374abed74946eafa7b0f87331c2e496fa61592))
+* polish input generator agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
+* polish structure plan ([3a0a196](https://github.com/AIGNE-io/aigne-doc-smith/commit/3a0a196a97196ba445c4709d3466ff355917ac53))
+* save docs remove useless docs ([bec5ba3](https://github.com/AIGNE-io/aigne-doc-smith/commit/bec5ba3afd462c990a0aa813bbe38ce9a61363ee))
+
+
+### Miscellaneous Chores
+
+* release 0.0.2 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))

package/README.md

@@ -61,17 +61,36 @@ Contributions are welcome! Please feel free to submit a pull request or open an
 npx --no doc-smith run --entry-agent init
 
 # 生成命令
-npx --no doc-smith run --input @./doc-smith/input.yaml --format yaml --entry-agent generator --model gemini:gemini-2.5-pro
+npx --no doc-smith run --entry-agent generator --model gemini:gemini-2.5-flash
 
 # 重新生成单篇
-npx --no doc-smith run --input @./doc-smith/input.yaml --format yaml --entry-agent regenerator --input-currentPath /overview --input-feedback "输出只能使用 markdown 格式，不能使用 html 标签" --model gemini:gemini-2.5-pro
+npx --no doc-smith run --entry-agent regenerator --input-path bitnet-m4XQ-core-concepts-quantization
 
 # 结构规划优化
-npx --no doc-smith run --input @./doc-smith/input.yaml --format yaml --entry-agent generator --input-structurePlanFeedback "删除 Contributing 下的子节点，只保留主节点，相关信息在主节点中显示" --model gemini:gemini-2.5-pro
+npx --no doc-smith run --input @./doc-smith/config.yaml --format yaml --entry-agent generator --input-structurePlanFeedback "补充节点的 sourceIds，确保所有节点 sourceIds 都有值" --model gemini:gemini-2.5-pro
 
 
 # 发布文档
-npx --no doc-smith run --input @./doc-smith/input.yaml --format yaml --entry-agent publish
+npx --no doc-smith run --input @./doc-smith/config.yaml --format yaml --entry-agent publish
+
+
+```
+
+使用 `aigne doc` 运行
+
+```shell
+# 初始化
+aigne doc init
+
+# 生成文档
+aigne doc generator
+
+# 优化单篇文档
+aigne doc regenerator --path bitnet-m4XQ-core-concepts-quantization # 可使用 structure-plan.json 中的 path ，或 Discuss Kit 中访问的 path
+
+# 发布文档
+aigne doc publish
+
 
 ```
 

package/agents/detail-regenerator.yaml

@@ -1,7 +1,8 @@
 type: team
 name: regenerator
-description: 生成文档详情并翻译
+description: Optimize and regenerate individual document content and translations
 skills:
+  - ./load-config.mjs
   - ./load-sources.mjs
   - type: transform
     jsonata: |
@@ -19,80 +20,78 @@ skills:
           })
         }
       ])
-  - type: transform
-    jsonata: |
-      (
-        $array := structurePlanResult;
-        $path := currentPath;
-        $foundItem := $array[path=$path][0];
-        $merge([
-            $foundItem,
-            { "originalStructurePlan": originalStructurePlan }
-            
-        ])
-      )
+  - ./find-item-by-path.mjs
   - ./format-structure-plan.mjs
   - ./detail-generator-and-translate.yaml
 input_schema:
   type: object
   properties:
-    nodeName:
-      type: string
-      description: 节点名称
-      default: 部分
-    locale:
-      type: string
-      description: 语言
-    targetAudience:
+    config:
       type: string
-      description: 目标受众
+      description: Path to the config file
+      default: ./doc-smith/config.yaml
+    # nodeName:
+    #   type: string
+    #   description: Name of the section to generate documentation for
+    #   default: Section
+    # locale:
+    #   type: string
+    #   description: Primary language for documentation (e.g., zh, en)
+    # targetAudience:
+    #   type: string
+    #   description: Target audience for the documentation
     glossary:
       type: string
-      description: 术语表
-    currentPath:
+      description: Glossary of terms for consistent terminology
+    path:
       type: string
-      description: 当前路径
+      description: Document path to regenerate
     feedback:
       type: string
-      description: 反馈
-    sources:
-      type: array
-      items:
-        type: string
-        description: 源码路径
-    sourcesPath:
-      type: array
-      items:
-        type: string
-        description: 源码路径
-      default:
-        - ./
-    includePatterns:
-      type: array
-      items:
-        type: string
-        description: 包含的文件名
-    excludePatterns:
-      type: array
-      items:
-        type: string
-        description: 排除的文件名
-    outputDir:
-      type: string
-      description: 输出目录
-      default: ./aigne-docs/output
-    docsDir:
-      type: string
-      description: 文档目录
-      default: ./aigne-docs/docs
-    additionalInformation:
-      type: string
-      description: 额外补充信息
-    labels:
-      type: array
-      items:
-        type: string
-        description: 标签
+      description: Feedback for content improvement
+    # sources:
+    #   type: array
+    #   items:
+    #     type: string
+    #   description: Source code files for documentation generation
+    # sourcesPath:
+    #   type: array
+    #   description: Source code paths
+    #   items:
+    #     type: string
+    #   default:
+    #     - ./
+    # includePatterns:
+    #   type: array
+    #   description: File patterns to include
+    #   items:
+    #     type: string
+    # excludePatterns:
+    #   type: array
+    #   description: File patterns to exclude
+    #   items:
+    #     type: string
+    # outputDir:
+    #   type: string
+    #   description: Output directory for intermediate files
+    #   default: ./doc-smith/output
+    # docsDir:
+    #   type: string
+    #   description: Directory to save generated documentation
+    #   default: ./doc-smith/docs
+    # additionalInformation:
+    #   type: string
+    #   description: Additional context or information for documentation
+    # translateLanguages:
+    #   type: array
+    #   items:
+    #     type: string
+    #     description: Target languages for translation (e.g., zh, en)
+    # labels:
+    #   type: array
+    #   items:
+    #     type: string
+    #     description: Tags or labels for categorization
 output_schema:
   type: object
   properties:

package/agents/docs-generator.yaml

@@ -1,7 +1,8 @@
 type: team
 name: generator
-description: 文档生成
+description: Automatically generates comprehensive project documentation
 skills:
+  - ./load-config.mjs
   - ./load-sources.mjs
   - ./check-structure-planning.mjs
   - type: transform
@@ -34,60 +35,73 @@ skills:
 input_schema:
   type: object
   properties:
-    nodeName:
+    config:
       type: string
-      description: 节点名称
-      default: Section
-    rules:
-      type: string
-      description: 用户的结构规划的要求和规则
-    locale:
-      type: string
-      description: 用户语言，如 zh、en
-    sources:
-      type: array
-      items:
-        type: string
-      description: 用户生成文档的源码文件
-    sourcesPath:
-      type: array
-      items:
-        type: string
-        description: 源码路径
-      default:
-        - ./
-    docsDir:
-      type: string
-      description: 文档保存目录
-      default: ./aigne-docs/docs
-    outputDir:
-      type: string
-      description: 输出目录
-      default: ./aigne-docs/output
-    translateLanguages:
-      type: array
-      items:
-        type: string
-        description: 翻译语言，如 zh、en
+      description: Path to the config file
+      default: ./doc-smith/config.yaml
+    # nodeName:
+    #   type: string
+    #   description: Name of the section to generate documentation for
+    #   default: Section
+    # rules:
+    #   type: string
+    #   description: Documentation generation requirements and rules
+    # locale:
+    #   type: string
+    #   description: Primary language for documentation (e.g., zh, en)
+    # sources:
+    #   type: array
+    #   items:
+    #     type: string
+    #   description: Source code files for documentation generation
+    # sourcesPath:
+    #   type: array
+    #   description: Source code paths
+    #   items:
+    #     type: string
+    #   default:
+    #     - ./
+    # includePatterns:
+    #   type: array
+    #   description: File patterns to include
+    #   items:
+    #     type: string
+    # excludePatterns:
+    #   type: array
+    #   description: File patterns to exclude
+    #   items:
+    #     type: string
+    # docsDir:
+    #   type: string
+    #   description: Directory to save generated documentation
+    #   default: ./doc-smith/docs
+    # outputDir:
+    #   type: string
+    #   description: Output directory for intermediate files
+    #   default: ./doc-smith/output
+    # translateLanguages:
+    #   type: array
+    #   items:
+    #     type: string
+    #     description: Target languages for translation (e.g., zh, en)
     glossary:
       type: string
-      description: 术语表
-    additionalInformation:
-      type: string
-      description: 额外补充信息
-    docsType:
-      type: string
-      description: 文档类型，支持：general、getting-started、reference、faq
-      default: general
+      description: Glossary of terms for consistent terminology
+    # additionalInformation:
+    #   type: string
+    #   description: Additional context or information for documentation
+    # docsType:
+    #   type: string
+    #   description: Type of documentation (general, getting-started, reference, faq)
+    #   default: general
     structurePlanFeedback:
       type: string
-      description: 结构规划反馈
-    labels:
-      type: array
-      items:
-        type: string
-        description: 标签
+      description: Feedback for structure planning adjustments
+    # labels:
+    #   type: array
+    #   items:
+    #     type: string
+    #     description: Tags or labels for categorization
   required:
-    - rules
-    - docsDir
+    - config
 mode: sequential

package/agents/find-item-by-path.mjs

@@ -0,0 +1,39 @@
+export default async function findItemByPath({
+  path,
+  structurePlanResult,
+  boardId,
+}) {
+  let foundItem = null;
+
+  // First try direct path matching
+  foundItem = structurePlanResult.find((item) => item.path === path);
+
+  // If not found and boardId is provided, try boardId-flattenedPath format matching
+  if (!foundItem && boardId) {
+    // Check if path starts with boardId followed by a dash
+    if (path.startsWith(`${boardId}-`)) {
+      // Extract the flattened path part after boardId-
+      const flattenedPath = path.substring(boardId.length + 1);
+
+      // Find item by comparing flattened paths
+      foundItem = structurePlanResult.find((item) => {
+        // Convert item.path to flattened format (replace / with -)
+        const itemFlattenedPath = item.path
+          .replace(/^\//, "")
+          .replace(/\//g, "-");
+        return itemFlattenedPath === flattenedPath;
+      });
+    }
+  }
+
+  if (!foundItem) {
+    throw new Error(
+      `Item with path "${path}" not found in structurePlanResult`
+    );
+  }
+
+  // Merge the found item with originalStructurePlan
+  return {
+    ...foundItem,
+  };
+}

package/agents/input-generator.mjs

@@ -9,7 +9,7 @@ import { join, dirname } from "node:path";
  * @returns {Promise<Object>}
  */
 export default async function init(
-  { outputPath = "./doc-smith", fileName = "input.yaml" },
+  { outputPath = "./doc-smith", fileName = "config.yaml" },
   options
 ) {
   console.log("Welcome to AIGNE Doc Smith!");
@@ -31,16 +31,16 @@ export default async function init(
   console.log("\n=== Target Audience ===");
   const targetAudienceInput = await options.prompts.input({
     message:
-      "What is the target audience? (e.g., developers, users, press Enter to skip):",
+      "What is the target audience? (e.g., developers, users, press Enter for default 'developers'):",
   });
-  input.targetAudience = targetAudienceInput.trim() || "";
+  input.targetAudience = targetAudienceInput.trim() || "developers";
 
   // 3. Language settings
   console.log("\n=== Language Settings ===");
   const localeInput = await options.prompts.input({
-    message: "Primary language (e.g., en, zh, press Enter to skip):",
+    message: "Primary language (e.g., en, zh, press Enter for default 'en'):",
   });
-  input.locale = localeInput.trim() || "";
+  input.locale = localeInput.trim() || "en";
 
   // 4. Translation languages
   console.log("\n=== Translation Settings ===");
@@ -89,25 +89,19 @@ export default async function init(
 function generateYAML(input, outputPath) {
   let yaml = "";
 
-  // Add rules
-  if (input.rules) {
-    yaml += `rules: |\n`;
+  // Add rules (required field)
+  yaml += `rules: |\n`;
+  if (input.rules && input.rules.trim()) {
     yaml += `  ${input.rules.split("\n").join("\n  ")}\n\n`;
+  } else {
+    yaml += `  \n\n`;
   }
 
   // Add target audience
-  if (input.targetAudience && input.targetAudience.trim()) {
-    yaml += `targetAudience: ${input.targetAudience}\n`;
-  } else {
-    yaml += `# targetAudience: developers  # Target audience for the documentation (e.g., developers, users)\n`;
-  }
+  yaml += `targetAudience: ${input.targetAudience}\n`;
 
   // Add language settings
-  if (input.locale && input.locale.trim()) {
-    yaml += `locale: ${input.locale}\n`;
-  } else {
-    yaml += `# locale: en  # Primary language for the documentation (e.g., en, zh)\n`;
-  }
+  yaml += `locale: ${input.locale}\n`;
 
   // Add translation languages
   if (
@@ -136,7 +130,5 @@ function generateYAML(input, outputPath) {
   return yaml;
 }
 
-// Execute the function if this file is run directly
-if (import.meta.url === `file://${process.argv[1]}`) {
-  inputGenerator({}).catch(console.error);
-}
+init.description =
+  "Generate a configuration file for the documentation generation process";

package/agents/load-config.mjs

@@ -0,0 +1,43 @@
+import path from "node:path";
+import fs from "node:fs/promises";
+import { parse } from "yaml";
+
+export default async function loadConfig({ config }) {
+  const configPath = path.join(process.cwd(), config);
+
+  try {
+    // Check if config file exists
+    await fs.access(configPath);
+  } catch (error) {
+    console.log(`Config file not found: ${configPath}`);
+    console.log("Please run 'aigne doc init' to create the config file.");
+    throw new Error(`Config file not found: ${configPath}`);
+  }
+
+  try {
+    // Read and parse YAML file
+    const configContent = await fs.readFile(configPath, "utf-8");
+    const parsedConfig = parse(configContent);
+    return {
+      nodeName: "Section",
+      locale: "en",
+      sourcesPath: ["./"],
+      docDir: "./doc-smith/docs",
+      outputDir: "./doc-smith/output",
+      ...parsedConfig,
+    };
+  } catch (error) {
+    console.error(`Error parsing config file: ${error.message}`);
+    throw new Error(`Failed to parse config file: ${error.message}`);
+  }
+}
+
+loadConfig.input_schema = {
+  type: "object",
+  properties: {
+    config: {
+      type: "string",
+      default: "./doc-smith/config.yaml",
+    },
+  },
+};

package/agents/load-sources.mjs

@@ -44,8 +44,9 @@ const DEFAULT_EXCLUDE_PATTERNS = [
   "**/*test/**",
   "**/*tests/**",
   "**/*examples/**",
+  "**/playgrounds/**",
   "v1/**",
-  "**/*dist/**",
+  "**/dist/**",
   "**/*build/**",
   "**/*experimental/**",
   "**/*deprecated/**",
@@ -59,6 +60,7 @@ const DEFAULT_EXCLUDE_PATTERNS = [
   "**/*bin/**",
   "**/*node_modules/**",
   "*.log",
+  "**/*test.*",
 ];
 
 /**

package/agents/publish-docs.mjs

@@ -117,7 +117,7 @@ async function getAccessToken(appUrl) {
 }
 
 /**
- * Save boardId to input.yaml file if it was auto-created
+ * Save boardId to config.yaml file if it was auto-created
  * @param {string} boardId - The original boardId (may be empty)
  * @param {string} newBoardId - The boardId returned from publishDocsFn
  */
@@ -130,7 +130,7 @@ async function saveBoardIdToInput(boardId, newBoardId) {
         mkdirSync(docSmithDir, { recursive: true });
       }
 
-      const inputFilePath = join(docSmithDir, "input.yaml");
+      const inputFilePath = join(docSmithDir, "config.yaml");
       let fileContent = "";
 
       // Read existing file content if it exists
@@ -156,12 +156,12 @@ async function saveBoardIdToInput(boardId, newBoardId) {
       await writeFile(inputFilePath, fileContent);
       console.log(`Board ID saved to: ${inputFilePath}`);
     } catch (error) {
-      console.warn("Failed to save board ID to input.yaml:", error.message);
+      console.warn("Failed to save board ID to config.yaml:", error.message);
     }
   }
 }
 
-export default async function publish({ docsDir, appUrl, boardId }) {
+export default async function publishDocs({ docsDir, appUrl, boardId }) {
   const accessToken = await getAccessToken(appUrl);
 
   process.env.DOC_ROOT_DIR = docsDir;
@@ -180,7 +180,7 @@ export default async function publish({ docsDir, appUrl, boardId }) {
     autoCreateBoard: !boardId,
   });
 
-  // Save boardId to input.yaml if it was auto-created
+  // Save boardId to config.yaml if it was auto-created
   await saveBoardIdToInput(boardId, newBoardId);
 
   return {
@@ -190,7 +190,7 @@ export default async function publish({ docsDir, appUrl, boardId }) {
   };
 }
 
-publish.input_schema = {
+publishDocs.input_schema = {
   type: "object",
   properties: {
     docsDir: {
@@ -210,3 +210,5 @@ publish.input_schema = {
     },
   },
 };
+
+publishDocs.description = "Publish the documentation to Discuss Kit";

package/agents/save-docs.mjs

@@ -12,6 +12,7 @@ export default async function saveDocs({
   structurePlanResult: structurePlan,
   docsDir,
   translateLanguages = [],
+  locale,
 }) {
   const results = [];
 
@@ -30,7 +31,8 @@ export default async function saveDocs({
     const cleanupResults = await cleanupInvalidFiles(
       structurePlan,
       docsDir,
-      translateLanguages
+      translateLanguages,
+      locale
     );
     results.push(...cleanupResults);
   } catch (err) {
@@ -40,14 +42,31 @@ export default async function saveDocs({
   return { saveDocsResult: results };
 }
 
+/**
+ * Generate filename based on flatName and language
+ * @param {string} flatName - Flattened path name
+ * @param {string} language - Language code
+ * @returns {string} - Generated filename
+ */
+function generateFileName(flatName, language) {
+  const isEnglish = language === "en";
+  return isEnglish ? `${flatName}.md` : `${flatName}.${language}.md`;
+}
+
 /**
  * Clean up .md files that are no longer in the structure plan
  * @param {Array<{path: string, title: string}>} structurePlan
  * @param {string} docsDir
  * @param {Array<string>} translateLanguages
+ * @param {string} locale - Main language locale (e.g., 'en', 'zh', 'fr')
  * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
  */
-async function cleanupInvalidFiles(structurePlan, docsDir, translateLanguages) {
+async function cleanupInvalidFiles(
+  structurePlan,
+  docsDir,
+  translateLanguages,
+  locale
+) {
   const results = [];
 
   try {
@@ -61,12 +80,14 @@ async function cleanupInvalidFiles(structurePlan, docsDir, translateLanguages) {
     // Add main document files
     for (const { path } of structurePlan) {
       const flatName = path.replace(/^\//, "").replace(/\//g, "-");
-      const fileName = `${flatName}.md`;
-      expectedFiles.add(fileName);
+
+      // Main language file
+      const mainFileName = generateFileName(flatName, locale);
+      expectedFiles.add(mainFileName);
 
       // Add translation files for each language
       for (const lang of translateLanguages) {
-        const translateFileName = `${flatName}.${lang}.md`;
+        const translateFileName = generateFileName(flatName, lang);
         expectedFiles.add(translateFileName);
       }
     }

package/agents/save-single-doc.mjs

@@ -6,6 +6,7 @@ export default async function saveSingleDoc({
   docsDir,
   translates,
   labels,
+  locale,
 }) {
   const results = await saveDocWithTranslations({
     path,
@@ -13,6 +14,7 @@ export default async function saveSingleDoc({
     docsDir,
     translates,
     labels,
+    locale,
   });
   return { saveSingleDocResult: results };
 }

package/agents/team-publish-docs.yaml

@@ -0,0 +1,13 @@
+type: team
+name: publish
+description: Publish the documentation to Discuss Kit
+skills:
+  - load-config.mjs
+  - publish-docs.mjs
+input_schema:
+  type: object
+  properties:
+    config:
+      type: string
+      description: Path to the config file
+      default: ./doc-smith/config.yaml

package/aigne.yaml

@@ -6,7 +6,6 @@ chat_model:
   # name: gemini-2.5-flash-preview-05-20
   temperature: 0.8
 agents:
-  - ./agents/docs-generator.yaml
   - ./agents/structure-planning.yaml
   - ./agents/batch-docs-detail-generator.yaml
   - ./agents/load-sources.mjs
@@ -23,6 +22,10 @@ agents:
   - ./agents/reflective-structure-planner.yaml
   - ./agents/check-structure-planning-result.yaml
   - ./agents/input-generator.mjs
+  - ./agents/docs-generator.yaml
   - ./agents/detail-regenerator.yaml
   - ./agents/publish-docs.mjs
   - ./agents/format-structure-plan.mjs
+  - ./agents/load-config.mjs
+  - ./agents/team-publish-docs.yaml
+  - ./agents/find-item-by-path.mjs

package/package.json

@@ -1,18 +1,11 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "publishConfig": {
     "access": "public"
   },
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "biome check && pnpm -r run lint",
-    "update:deps": "npx -y taze major -r -w -f -n '/@abtnode|@aigne|@arcblock|@blocklet|@did-connect|@did-pay|@did-space|@nft-store|@nft-studio|@ocap/' && pnpm install && pnpm run deduplicate",
-    "deduplicate": "pnpm dedupe",
-    "lint:fix": "biome check --write && pnpm -r run lint"
-  },
   "type": "module",
   "bin": "aigne.yaml",
   "keywords": [],
@@ -20,14 +13,21 @@
   "license": "MIT",
   "dependencies": {
     "@aigne/anthropic": "^0.10.2",
-    "@aigne/cli": "^1.26.0",
+    "@aigne/cli": "^1.27.0",
     "@aigne/core": "^1.39.0",
     "@aigne/gemini": "^0.8.6",
     "@aigne/openai": "^0.10.6",
-    "@aigne/publish-docs": "^0.4.0",
+    "@aigne/publish-docs": "^0.5.0",
     "glob": "^11.0.3",
     "open": "^10.2.0",
     "ufo": "^1.6.1",
     "yaml": "^2.8.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "biome check && pnpm -r run lint",
+    "update:deps": "npx -y taze major -r -w -f -n '/@abtnode|@aigne|@arcblock|@blocklet|@did-connect|@did-pay|@did-space|@nft-store|@nft-studio|@ocap/' && pnpm install && pnpm run deduplicate",
+    "deduplicate": "pnpm dedupe",
+    "lint:fix": "biome check --write && pnpm -r run lint"
   }
-}
+}

package/prompts/check-structure-planning-result.md

@@ -23,6 +23,7 @@
 你的主要目标是验证两条关键规则：
 1.  **反馈的实现**：新的结构规划**必须**正确地实现用户反馈中要求的所有变更。
 2.  **无关节点的稳定性**：没有在用户反馈中被提及的节点**绝不能**被修改，特别是它们的 `path` 属性。`path` 是关联现有内容的关键标识符，其稳定性至关重要。
+3.  **数据有效性**: 所有 {{ nodeName }} 都有关联数据源，sourceIds 中都有值。
 </goal>
 
 <rules>
@@ -71,6 +72,15 @@
       "reason": "The new structure plan modified unrelated nodes, which is not allowed. [Please provide specific details, e.g.: 'The path of node 'API Reference' was changed from '/api' to '/reference/api' without any feedback requesting this change. This is a critical error.']"
     }
     ```
+
+*  ** 如果数据无效 **：
+    ```json
+    {
+      "isValid": false,
+      "reason": "The structure plan contains nodes without associated data sources. Each node must have at least one source file linked through sourcesIds."
+    }
+    ```
+
 *   **如果是首次运行**：
 
     ```json

package/prompts/content-detail-generator.md

@@ -64,8 +64,10 @@ parentId: {{parentId}}
 - 结合当前{{nodeName}}的标题、描述，合理规划{{nodeName}}内容结构，内容要丰富、有条理、有吸引力。
 - 内容风格需要匹配目标受众
 - 明确区分与 structurePlan 其他{{nodeName}}的内容，避免重复，突出本{{nodeName}}的独特价值。
+{% if enforceInfoCompleteness %}
 - 如果 DataSources 相关信息不足，直接返回错误信息，提示用户补充内容，要确保页面内容足够丰富，你可以放心的向用户提出补充信息的要求。
 - 只展示有价值、能吸引用户的信息，如信息不足，提示用户补充信息
+{% endif %}
 - 输出为完整的信息，包含{{nodeName}}计划展示的全部信息。
 - 确保每个{{nodeName}}的详情中，都包含一个 markdown 的一级标题，展示当前{{nodeName}}的标题：{{title}}
 - markdown 输出内容正常换行、添加空行，让内容容易阅读

package/utils/utils.mjs

@@ -34,6 +34,7 @@ export function processContent({ content }) {
  * @param {string} params.path - Relative path (without extension)
  * @param {string} params.content - Main document content
  * @param {string} params.docsDir - Root directory
+ * @param {string} params.locale - Main content language (e.g., 'en', 'zh', 'fr')
  * @param {Array<{language: string, translation: string}>} [params.translates] - Translation content
  * @param {Array<string>} [params.labels] - Document labels for front matter
  * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
@@ -42,6 +43,7 @@ export async function saveDocWithTranslations({
   path: docPath,
   content,
   docsDir,
+  locale,
   translates = [],
   labels,
 }) {
@@ -49,10 +51,18 @@ export async function saveDocWithTranslations({
   try {
     // Flatten path: remove leading /, replace all / with -
     const flatName = docPath.replace(/^\//, "").replace(/\//g, "-");
-    const fileFullName = `${flatName}.md`;
-    const filePath = path.join(docsDir, fileFullName);
     await fs.mkdir(docsDir, { recursive: true });
 
+    // Helper function to generate filename based on language
+    const getFileName = (language) => {
+      const isEnglish = language === "en";
+      return isEnglish ? `${flatName}.md` : `${flatName}.${language}.md`;
+    };
+
+    // Save main content with appropriate filename based on locale
+    const mainFileName = getFileName(locale);
+    const mainFilePath = path.join(docsDir, mainFileName);
+
     // Add labels front matter if labels are provided
     let finalContent = processContent({ content });
     if (labels && labels.length > 0) {
@@ -60,11 +70,12 @@ export async function saveDocWithTranslations({
       finalContent = frontMatter + finalContent;
     }
 
-    await fs.writeFile(filePath, finalContent, "utf8");
-    results.push({ path: filePath, success: true });
+    await fs.writeFile(mainFilePath, finalContent, "utf8");
+    results.push({ path: mainFilePath, success: true });
 
+    // Process all translations
     for (const translate of translates) {
-      const translateFileName = `${flatName}.${translate.language}.md`;
+      const translateFileName = getFileName(translate.language);
       const translatePath = path.join(docsDir, translateFileName);
 
       // Add labels front matter to translation content if labels are provided