@aigne/doc-smith 0.8.5 → 0.8.7

package/agents/publish/index.yaml

@@ -0,0 +1,17 @@
+type: team
+name: publish
+alias:
+  - pub
+  - p
+description: Publish your documentation online
+skills:
+  - url: ../init/index.mjs
+    default_input:
+      skipIfExists: true
+  - publish-docs.mjs
+input_schema:
+  type: object
+  properties:
+    appUrl:
+      type: string
+      description: Website URL where docs will be published (optional - leave empty for interactive setup)

package/agents/{publish-docs.mjs → publish/publish-docs.mjs}

@@ -1,13 +1,14 @@
 import { basename, join } from "node:path";
+
 import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
 import chalk from "chalk";
 import fs from "fs-extra";
 
-import { getAccessToken } from "../utils/auth-utils.mjs";
-import { DISCUSS_KIT_STORE_URL, TMP_DIR, TMP_DOCS_DIR } from "../utils/constants.mjs";
-import { deploy } from "../utils/deploy.mjs";
-import { beforePublishHook, ensureTmpDir } from "../utils/kroki-utils.mjs";
-import { getGithubRepoUrl, loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
+import { getAccessToken } from "../../utils/auth-utils.mjs";
+import { DISCUSS_KIT_STORE_URL, TMP_DIR, TMP_DOCS_DIR } from "../../utils/constants.mjs";
+import { beforePublishHook, ensureTmpDir } from "../../utils/d2-utils.mjs";
+import { deploy } from "../../utils/deploy.mjs";
+import { getGithubRepoUrl, loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
 
 const DEFAULT_APP_URL = "https://docsmith.aigne.io";
 
@@ -53,21 +54,17 @@ export default async function publishDocs(
       message: "Select platform to publish your documents:",
       choices: [
         {
-          name:
-            chalk.blue("Publish to docsmith.aigne.io") +
-            " - free, but your documents will be publicly accessible, recommended for open-source projects",
+          name: `${chalk.blue("DocSmith Cloud (docsmith.aigne.io)")} – ${chalk.green("Free")} hosting. Your documents will be publicly accessible. Best for open-source projects or community sharing.`,
           value: "default",
         },
         {
-          name: `${chalk.blue("Publish to your existing website")} - use your current website`,
+          name: `${chalk.blue("Your existing website")} - Integrate and publish directly on your current site (setup required)`,
           value: "custom",
         },
         ...(hasCachedCheckoutId && hasDocSmithBaseUrl
           ? [
               {
-                name:
-                  chalk.yellow("Continue your previous website setup") +
-                  " - resume from where you left off",
+                name: `${chalk.yellow("Resume previous website setup")} - ${chalk.green("Already paid.")} Continue where you left off. Your payment is already processed.`,
                 value: "new-instance-continue",
               },
             ]
@@ -75,7 +72,7 @@ export default async function publishDocs(
         ...(hasDocSmithBaseUrl
           ? [
               {
-                name: `${chalk.blue("Publish to a new website")} - we'll help you set up a new website`,
+                name: `${chalk.blue("New website")} - ${chalk.yellow("Paid service.")} We'll help you set up a brand-new website with custom domain and hosting. Great if you want a professional presence.`,
                 value: "new-instance",
               },
             ]
@@ -113,7 +110,7 @@ export default async function publishDocs(
           paymentUrl = config?.paymentUrl;
           console.log(`\nResuming your previous website setup...`);
         } else {
-          console.log(`\nCreating a new doc website for your documentation...`);
+          console.log(`\nCreating new website for your documentation...`);
         }
         const { appUrl: homeUrl, token: ltToken } = (await deploy(id, paymentUrl)) || {};
 
@@ -127,6 +124,8 @@ export default async function publishDocs(
     }
   }
 
+  console.log(`\nPublishing docs to ${chalk.cyan(appUrl)}\n`);
+
   const accessToken = await getAccessToken(appUrl, token);
 
   process.env.DOC_ROOT_DIR = docsDir;
@@ -185,7 +184,7 @@ export default async function publishDocs(
   } catch (error) {
     message = `❌ Failed to publish docs: ${error.message}`;
   }
-  saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
+  await saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
 
   // clean up tmp work dir
   await fs.rm(docsDir, { recursive: true, force: true });
@@ -211,4 +210,4 @@ publishDocs.input_schema = {
   },
 };
 
-publishDocs.description = "Publish the documentation to Discuss Kit";
+publishDocs.description = "Publish the documentation to website";

package/agents/schema/{structure-plan-result.yaml → document-execution-structure.yaml}

@@ -8,7 +8,7 @@ items:
       type: string
     path:
       type: string
-      description: 路径，以 RUL 的格式返回，不能为空, 必须以 / 开头，不需要包含语言层级，比如 /zh/about 直接返回 /about
+      description: Path in URL format, cannot be empty, must start with /, no need to include language level, e.g., /zh/about should return /about
     parentId:
       type:
         - string
@@ -20,12 +20,12 @@ items:
         properties:
           language:
             type: string
-            description: 语言代码，比如 zh, en, ja 等
+            description: Language code, such as zh, en, ja, etc.
     sourceIds:
       type: array
       items:
         type: string
-      description: 关联的 dataSources 中的 sourceId，用于后续的翻译和内容生成，必须来自 datasources 中的 sourceId，不能有虚假的 id, 不能为空
+      description: Associated sourceId from dataSources for subsequent translation and content generation, must come from sourceId in datasources, cannot have fake ids, cannot be empty
   required:
     - title
     - description

package/agents/schema/document-structure.yaml

@@ -0,0 +1,26 @@
+type: array
+items:
+  type: object
+  properties:
+    title:
+      type: string
+    description:
+      type: string
+    path:
+      type: string
+      description: Path in URL format, cannot be empty, cannot contain spaces or special characters, must start with /, no need to include language level, e.g., /zh/about should return /about
+    parentId:
+      type:
+        - string
+        - "null"
+      description: Parent node path, if null indicates it is a top-level node
+    sourceIds:
+      type: array
+      description: Associated sourceId from dataSources for subsequent translation and content generation, must come from sourceId in datasources, cannot have fake ids, **cannot be empty**
+      items:
+        type: string
+  required:
+    - title
+    - description
+    - path
+    - sourceIds

package/agents/{language-selector.mjs → translate/choose-language.mjs}

@@ -1,5 +1,5 @@
-import { SUPPORTED_LANGUAGES } from "../utils/constants.mjs";
-import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
+import { SUPPORTED_LANGUAGES } from "../../utils/constants.mjs";
+import { loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
 
 /**
  * Interactive language selector for translation from configured languages
@@ -9,7 +9,7 @@ import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
  * @param {Object} options - Options object with prompts
  * @returns {Promise<Object>} Selected languages
  */
-export default async function languageSelector({ langs, locale, selectedDocs }, options) {
+export default async function chooseLanguage({ langs, locale, selectedDocs }, options) {
   let selectedLanguages = [];
 
   // Load existing config to get current translation languages
@@ -19,7 +19,7 @@ export default async function languageSelector({ langs, locale, selectedDocs },
   // Get primary language from config or parameter
   const primaryLanguage = locale || existingConfig?.locale || "en";
 
-  // Filter out the primary language from available choices (like input-generator.mjs)
+  // Filter out the primary language from available choices (like init.mjs)
   const availableTranslationLanguages = SUPPORTED_LANGUAGES.filter(
     (lang) => lang.code !== primaryLanguage,
   );
@@ -90,7 +90,7 @@ export default async function languageSelector({ langs, locale, selectedDocs },
   };
 }
 
-languageSelector.input_schema = {
+chooseLanguage.input_schema = {
   type: "object",
   properties: {
     langs: {

package/agents/{retranslate.yaml → translate/index.yaml}

@@ -1,20 +1,19 @@
 type: team
 name: translate
-description: Translate document content to selected languages
+description: Translate documents into other languages
 skills:
-  - url: ./input-generator.mjs
+  - url: ../init/index.mjs
     default_input:
       skipIfExists: true
-  - ./load-config.mjs
-  - ./load-sources.mjs
+  - ../utils/load-sources.mjs
   - type: transform
     task_render_mode: hide
     jsonata: |
       $merge([
         $,
         {
-          'structurePlan': originalStructurePlan,
-          'structurePlanResult': $map(originalStructurePlan, function($item) {
+          'documentStructure': originalDocumentStructure,
+          'documentExecutionStructure': $map(originalDocumentStructure, function($item) {
             $merge([
               $item,
               {
@@ -24,42 +23,42 @@ skills:
           })
         }
       ])
-  - url: ./find-items-by-paths.mjs
+  - url: ../utils/choose-docs.mjs
     default_input:
       isTranslate: true
-  - ./language-selector.mjs
+  - ../translate/choose-language.mjs
   - type: team
-    name: batchDocsTranslate
+    name: batchTranslateDocument
     skills:
-      - ./batch-translate.yaml
-      - url: ./save-single-doc.mjs
+      - ../translate/translate-multilingual.yaml
+      - url: ../utils/save-single-doc.mjs
         default_input:
           isTranslate: true
     iterate_on: selectedDocs
     concurrency: 3
-  - url: ./check-feedback-refiner.mjs
+  - url: ../utils/check-feedback-refiner.mjs
     default_input:
       stage: translation_refine
-  - url: ./action-success.mjs
+  - url: ../utils/action-success.mjs
     default_input:
-      action: "Document translated"
+      action: "✅ Translation completed"
 input_schema:
   type: object
   properties:
     glossary:
       type: string
-      description: Glossary of terms for consistent terminology, use @<file> to read from a file
+      description: Glossary file for consistent terminology (use @filename.md)
     docs:
       type: array
       items:
         type: string
-      description: Document paths to translate
+      description: Documents to translate
     langs:
       type: array
       items:
         type: string
-      description: "Languages to translate to, available languages are: en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar"
+      description: "Target languages (available: en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar)"
     feedback:
       type: string
-      description: Feedback for translation improvement
+      description: Tell us how to improve the translation style
 mode: sequential

package/agents/translate/translate-document.yaml

@@ -0,0 +1,32 @@
+name: translateDocument
+description: Translate content to another language
+instructions:
+  url: ../../prompts/translate/translate-document.md
+task_render_mode: collapse
+input_schema:
+  type: object
+  properties:
+    language:
+      type: string
+      description: Target language (e.g., 'zh' for Chinese, 'ja' for Japanese)
+    content:
+      type: string
+      description: Text content to translate
+    glossary:
+      type: string
+      description: Glossary for consistent terminology
+    feedback:
+      type: string
+      description: Tell us how to improve the translation style
+  required:
+    - language
+    - content
+output_schema:
+  type: object
+  properties:
+    translation:
+      type: string
+      description: Translated text
+    language:
+      type: string
+      description: Language code of the translation

package/agents/{batch-translate.yaml → translate/translate-multilingual.yaml}

@@ -1,15 +1,15 @@
 type: team
-name: batchTranslate
-description: 批量翻译文档到多个语言
+name: translateMultilingual
+description: Batch translate documents to multiple languages
 skills:
   - type: team
     task_render_mode: collapse
     name: translate
     skills:
-      - url: ./find-user-preferences-by-path.mjs
+      - url: ../utils/find-user-preferences-by-path.mjs
         default_input:
           scope: translation
-      - ./translate.yaml
+      - ../translate/translate-document.yaml
       - type: transform
         jsonata: |
           $merge([
@@ -17,7 +17,7 @@ skills:
             { "reviewContent": translation }
           ])
     reflection:
-      reviewer: ./check-detail-result.mjs
+      reviewer: ../utils/check-detail-result.mjs
       is_approved: isApproved
       max_iterations: 5
       return_last_on_max_iterations: true

package/agents/update/batch-generate-document.yaml

@@ -0,0 +1,19 @@
+type: team
+name: batchGenerateDocument
+description: Batch generate document details
+skills:
+  - ./check-document.mjs
+input_schema:
+  type: object
+  properties:
+    datasources:
+      type: string
+      description: Context for document structure generation, used to assist generate document structure
+    documentExecutionStructure: ../schema/document-execution-structure.yaml
+    modifiedFiles:
+      type: array
+      items: { type: string }
+      description: Array of modified files since last generation
+iterate_on: documentExecutionStructure
+concurrency: 3
+mode: sequential

package/agents/{check-detail.mjs → update/check-document.mjs}

@@ -2,19 +2,19 @@ import { access, readFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import { TeamAgent } from "@aigne/core";
-import { hasSourceFilesChanged } from "../utils/utils.mjs";
-import checkDetailResult from "./check-detail-result.mjs";
+import { hasSourceFilesChanged } from "../../utils/utils.mjs";
+import checkDetailResult from "../utils/check-detail-result.mjs";
 
 // Get current script directory
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
-export default async function checkDetail(
+export default async function checkDocument(
   {
     path,
     docsDir,
     sourceIds,
-    originalStructurePlan,
-    structurePlan,
+    originalDocumentStructure,
+    documentStructure,
     modifiedFiles,
     forceRegenerate,
     ...rest
@@ -36,11 +36,11 @@ export default async function checkDetail(
     detailGenerated = false;
   }
 
-  // Check if sourceIds have changed by comparing with original structure plan
+  // Check if sourceIds have changed by comparing with original document structure
   let sourceIdsChanged = false;
-  if (originalStructurePlan && sourceIds) {
-    // Find the original node in the structure plan
-    const originalNode = originalStructurePlan.find((node) => node.path === path);
+  if (originalDocumentStructure && sourceIds) {
+    // Find the original node in the document structure
+    const originalNode = originalDocumentStructure.find((node) => node.path === path);
 
     if (originalNode?.sourceIds) {
       const originalSourceIds = originalNode.sourceIds;
@@ -82,9 +82,9 @@ export default async function checkDetail(
   // If file exists, check content validation
   let contentValidationFailed = false;
   let validationResult = {};
-  if (detailGenerated && fileContent && structurePlan) {
+  if (detailGenerated && fileContent && documentStructure) {
     validationResult = await checkDetailResult({
-      structurePlan,
+      documentStructure,
       reviewContent: fileContent,
       docsDir,
     });
@@ -111,8 +111,8 @@ export default async function checkDetail(
   }
 
   const teamAgent = TeamAgent.from({
-    name: "generateDetail",
-    skills: [options.context.agents["detailGeneratorAndTranslate"]],
+    name: "generateDocument",
+    skills: [options.context.agents["generateAndTranslateDocument"]],
   });
 
   const result = await options.context.invoke(teamAgent, {
@@ -120,8 +120,8 @@ export default async function checkDetail(
     docsDir,
     path,
     sourceIds,
-    originalStructurePlan,
-    structurePlan,
+    originalDocumentStructure,
+    documentStructure,
     detailFeedback: contentValidationFailed ? validationResult.detailFeedback : "",
   });
 
@@ -133,4 +133,4 @@ export default async function checkDetail(
   };
 }
 
-checkDetail.taskTitle = "Check if '{{ title }}' needs regeneration";
+checkDocument.taskTitle = "Check if '{{ title }}' needs generate or update";

package/agents/{detail-generator-and-translate.yaml → update/generate-and-translate-document.yaml}

@@ -1,16 +1,16 @@
 type: team
-name: detailGeneratorAndTranslate
-description: 生成文档详情并翻译
+name: generateAndTranslateDocument
+description: Generate document and translate
 skills:
-  - ./transform-detail-datasources.mjs
+  - ../utils/transform-detail-datasources.mjs
   - type: team
     task_render_mode: collapse
-    name: detailGenerate
+    name: generateDocumentContent
     skills:
-      - url: ./find-user-preferences-by-path.mjs
+      - url: ../utils/find-user-preferences-by-path.mjs
         default_input:
           scope: document
-      - ./content-detail-generator.yaml
+      - ../update/generate-document.yaml
       - type: transform
         jsonata: |
           $merge([
@@ -18,11 +18,11 @@ skills:
             { "reviewContent": content }
           ])
     reflection:
-      reviewer: ./check-detail-result.mjs
+      reviewer: ../utils/check-detail-result.mjs
       is_approved: isApproved
       max_iterations: 5
       return_last_on_max_iterations: true
-    task_title: Generate detail for '{{ title }}'
+    task_title: Generate document for '{{ title }}'
   - type: transform
     task_render_mode: hide
     jsonata: |
@@ -30,63 +30,63 @@ skills:
         $,
         { "feedback": "" }
       ])
-  - ./batch-translate.yaml
-  - ./save-single-doc.mjs
+  - ../translate/translate-multilingual.yaml
+  - ../utils/save-single-doc.mjs
 input_schema:
   type: object
   properties:
     nodeName:
       type: string
-      description: 节点名称
+      description: Node name
       default: Section
     locale:
       type: string
-      description: 语言
+      description: Language
     targetAudience:
       type: string
-      description: 目标受众
+      description: Target audience
     glossary:
       type: string
-      description: 术语表
+      description: Glossary
     doc-path:
       type: string
-      description: 当前路径
+      description: Current path
     feedback:
       type: string
-      description: 反馈
+      description: Feedback
     sources:
       type: array
       items:
         type: string
-        description: 源码路径
+        description: Source code path
     sourcesPath:
       type: array
       items:
         type: string
-        description: 源码路径
+        description: Source code path
       default:
         - ./
     includePatterns:
       type: array
       items:
         type: string
-        description: 包含的文件名
+        description: Included file names
     excludePatterns:
       type: array
       items:
         type: string
-        description: 排除的文件名
+        description: Excluded file names
     outputDir:
       type: string
-      description: 输出目录
+      description: Output directory
       default: ./aigne-docs/output
     docsDir:
       type: string
-      description: 文档目录
+      description: Documentation directory
       default: ./aigne-docs/docs
     additionalInformation:
       type: string
-      description: 额外补充信息
+      description: Additional information
 output_schema:
   type: object
   properties:

package/agents/update/generate-document.yaml

@@ -0,0 +1,50 @@
+name: generateDocument
+description: Comprehensive content generator for documentation that creates detailed, high-quality document content from various data sources with intelligent analysis.
+instructions:
+  url: ../../prompts/detail/generate-document.md
+input_schema:
+  type: object
+  properties:
+    rules:
+      type: string
+      description: User's content generation rules and requirements
+    locale:
+      type: string
+      description: User language, such as zh, en
+    datasources:
+      type: string
+      description: Source data and context for document content generation
+    targetAudience:
+      type: string
+      description: Target audience for document content
+    nodeName:
+      type: string
+      description: Document node name for content generation
+    originalDocumentStructure: ../schema/document-structure.yaml
+    title:
+      type: string
+    description:
+      type: string
+    path:
+      type: string
+    parentId:
+      type:
+        - string
+        - "null"
+    glossary:
+      type: string
+      description: Glossary
+    additionalInformation:
+      type: string
+      description: Additional supplementary information
+  required:
+    - rules
+    - datasources
+    - originalDocumentStructure
+output_schema:
+  type: object
+  properties:
+    content:
+      type: string
+  required:
+    - content