@aigne/doc-smith 0.9.8-alpha.3 → 0.9.8-alpha.4

package/agents/update/generate-diagram.yaml

@@ -1,63 +0,0 @@
-type: team
-task_render_mode: collapse
-name: generateDiagram
-skills:
-  # Step 1: Analyze document content to determine diagram type and style
-  - ../create/analyze-diagram-type.mjs
-  # Step 2: Transform output for image generation agent (map aspectRatio to ratio, add size)
-  - type: transform
-    jsonata: |
-      $merge([
-        $,
-        {
-          "ratio": aspectRatio,
-          "size": "1K"
-        }
-      ])
-  # Step 3: Generate diagram image directly with unified agent
-  - ../create/generate-diagram-image.yaml
-  # Step 4: Replace placeholder with generated image
-  - ../create/replace-d2-with-image.mjs
-input_schema:
-  type: object
-  properties:
-    documentContent:
-      type: string
-      description: The **raw text content** of the current document. (**Note:** This is the original document and **does not include** any diagram source code.)
-    locale:
-      type: string
-      description: Language for diagram labels and text
-      default: en
-    diagramming:
-      type: object
-      description: Diagramming configuration
-      properties:
-        style:
-          type: string
-          description: Default diagram style to use when no style is specified in feedback
-    feedback:
-      type: string
-      description: User feedback that may contain style or type preferences, or diagram index (e.g., 'use anthropomorphic style', 'update the second diagram')
-      default: ""
-    originalContent:
-      type: string
-      description: Original document content before modifications. Used to find existing diagrams when updating (may contain DIAGRAM_IMAGE_START, ```d2, or ```mermaid code blocks)
-    diagramIndex:
-      type: number
-      description: Index of the diagram to replace (0-based). If not provided, will try to extract from feedback.
-    path:
-      type: string
-      description: Document path (e.g., "guides/getting-started.md") used for generating image filename
-    docsDir:
-      type: string
-      description: Documentation directory where assets will be saved (relative to project root)
-  required:
-    - documentContent
-output_schema:
-  type: object
-  properties:
-    content:
-      type: string
-      description: The document content with D2 code blocks replaced by generated diagram image.
-  required:
-    - content

package/agents/update/generate-document.yaml

@@ -1,70 +0,0 @@
-name: generateDocument
-description: Comprehensive content generator for documentation that creates detailed, high-quality document content from various data sources with intelligent analysis.
-instructions:
-  - role: system
-    url: ../../prompts/detail/generate/system-prompt.md
-  - role: user
-    url: ../../prompts/detail/generate/user-prompt.md
-auto_reorder_system_messages: true
-auto_merge_system_messages: true
-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
-    detailDataSource:
-      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
-    originalContent:
-      type: string
-      description: The original content of the document before update
-    parentId:
-      type:
-        - string
-        - "null"
-    glossary:
-      type: string
-      description: Glossary
-    additionalInformation:
-      type: string
-      description: Additional supplementary information
-    intentType:
-      type:
-        - string
-        - "null"
-      description: User intent type analyzed from feedback (addDiagram, updateDiagram, deleteDiagram, updateDocument). Can be null if not specified.
-      enum: ["addDiagram", "updateDiagram", "deleteDiagram", "updateDocument", null]
-  required:
-    - rules
-    - detailDataSource
-    - originalDocumentStructure
-output_key: content
-afs:
-  modules:
-    - module: system-fs
-      options:
-        name: sources
-        localPath: .
-        description: |
-          Codebase of the project to be documented used as context for document generation,
-          should search and read as needed while generating document content
-keep_text_in_tool_uses: false
-# skills:
-#   - ./generate-diagram.yaml

package/agents/update/handle-document-update.yaml

@@ -1,103 +0,0 @@
-type: team
-name: handleDocumentUpdate
-description: Update a document in a batch
-skills:
-  - ../utils/transform-detail-data-sources.mjs
-  # Check if document generation should be skipped (if content already exists)
-  # If intentType is diagram-related and content exists, mark skipGenerateDocument so generation can be short-circuited
-  - url: ../utils/skip-if-content-exists.mjs
-  # Generate document content (skipped when skipGenerateDocument is true and content exists)
-  - type: team
-    task_render_mode: collapse
-    name: generateDocumentContent
-    skills:
-      - url: ../utils/find-user-preferences-by-path.mjs
-        default_input:
-          scope: document
-      - ../utils/generate-document-or-skip.mjs
-    reflection:
-      reviewer: ../utils/check-detail-result.mjs
-      is_approved: isApproved
-      max_iterations: 5
-      return_last_on_max_iterations: true
-    task_title: Generate document for '{{ title }}'
-  # Ensure content, documentContent, and originalContent are set
-  - type: transform
-    jsonata: |
-      $merge([
-        $,
-        { 
-          "documentContent": content,
-          "originalContent": content
-        }
-      ])
-  - ./check-generate-diagram.mjs
-  # - ../generate/merge-diagram.yaml
-  - ../utils/save-doc.mjs
-input_schema:
-  type: object
-  properties:
-    nodeName:
-      type: string
-      description: Node name
-      default: Section
-    locale:
-      type: string
-      description: Language
-    targetAudience:
-      type: string
-      description: Target audience
-    glossary:
-      type: string
-      description: Glossary
-    doc-path:
-      type: string
-      description: Current path
-    feedback:
-      type: string
-      description: Feedback
-    sources:
-      type: array
-      items:
-        type: string
-        description: Source code path
-    sourcesPath:
-      type: array
-      items:
-        type: string
-        description: Source code path
-      default:
-        - ./
-    includePatterns:
-      type: array
-      items:
-        type: string
-        description: Included file name patterns
-    excludePatterns:
-      type: array
-      items:
-        type: string
-        description: Excluded file name patterns
-    outputDir:
-      type: string
-      description: Output directory
-      default: ./aigne-docs/output
-    docsDir:
-      type: string
-      description: Documentation directory
-      default: ./aigne-docs/docs
-    additionalInformation:
-      type: string
-      description: Additional information
-output_schema:
-  type: object
-  properties:
-    title:
-      type: string
-    description:
-      type: string
-    path:
-      type: string
-    content:
-      type: string
-mode: sequential

package/agents/update/index.yaml

@@ -1,79 +0,0 @@
-type: team
-name: update
-alias:
-  - up
-description: Update specific documents and their translations. Use --diagram to filter and select documents with diagrams, --diagram-all to auto-update all diagrams, or --diagram-sync to sync existing images to translations.
-skills:
-  - url: ../init/index.mjs
-    default_input:
-      skipIfExists: true
-      checkOnly: true
-  - url: ../init/check.mjs
-  - ../utils/load-sources.mjs
-  - type: transform
-    task_render_mode: hide
-    jsonata: |
-      $merge([
-        $,
-        {
-          'documentStructure': originalDocumentStructure
-        }
-      ])
-  # Check if --diagram or --diagram-all flag is set
-  - url: ../update/check-diagram-flag.mjs
-  # Check if --diagram-sync flag is set
-  - url: ../update/check-sync-image-flag.mjs
-  - url: ../utils/choose-docs.mjs
-    default_input:
-      requiredFeedback: false
-  - ../utils/format-document-structure.mjs
-  - ../utils/ensure-document-icons.mjs
-  - ../media/load-media-description.mjs
-  - ../utils/analyze-feedback-intent.mjs
-  - ../update/sync-images-and-exit.mjs
-  - ../update/check-update-is-single.mjs
-  - ../update/save-and-translate-document.mjs
-  - url: ../utils/action-success.mjs
-    default_input:
-      action: "✅ Documents updated successfully!\n💡 Looks good? Run `aigne doc publish` to go live."
-input_schema:
-  type: object
-  properties:
-    # glossary:
-    #   type: string
-    #   description: Glossary file for consistent terminology (use @filename.md)
-    docs:
-      type: array
-      items:
-        type: string
-      description: Documents to update, use document path in document structure to specify, eg ["/getting-started", "/overview"]
-    feedback:
-      type: string
-      description: Tell us what to change in this content
-    isChat:
-      type: boolean
-      description: Whether the update is from chat
-    # reset:
-    #   type: boolean
-    #   description: Start fresh - ignore previous versions
-    # diagram:
-    #   type: ["boolean", "string"]
-    #   description: "Flag to update diagrams: true for user selection (can also use --diagram CLI arg)"
-    # "diagram-all":
-    #   type: ["boolean", "string"]
-    #   description: "Flag to auto-select all documents with diagrams (can also use --diagram-all CLI arg)"
-    # "diagram-sync":
-    #   type: ["boolean", "string"]
-    #   description: "Flag to sync existing banana images to translations (can also use --diagram-sync CLI arg or DOC_SMITH_SYNC_IMAGES env var)"
-output_schema:
-  type: object
-  properties:
-    title:
-      type: string
-    description:
-      type: string
-    path:
-      type: string
-    content:
-      type: string
-mode: sequential

package/agents/update/pre-check-generate-diagram.yaml

@@ -1,44 +0,0 @@
-name: preCheckGenerateDiagram
-description: Pre-check for generating diagram
-model:
-  reasoning_effort: 1
-instructions:
-  url: ../../prompts/detail/diagram/pre-check.md
-input_schema:
-  type: object
-  properties:
-    documentContent:
-      type: string
-      description: Source content of the document
-    feedback:
-      type: string
-      description: User generation feedback
-    detailFeedback:
-      type: string
-      description: Current document detail feedback
-    previousGenerationContent:
-      type: string
-      description: Previous document content
-  required:
-    - documentContent
-output_schema:
-  type: object
-  properties:
-    content:
-      type: string
-      description: Document content
-    details:
-      type: array
-      description: Detailed needDiagram score
-      items:
-        type: object
-        properties:
-          type:
-            type: string
-          score:
-            type: number
-          reason:
-            type: string
-  required:
-    - content
-

package/agents/update/save-and-translate-document.mjs

@@ -1,76 +0,0 @@
-import pMap from "p-map";
-import { recordUpdate } from "../../utils/history-utils.mjs";
-
-export default async function saveAndTranslateDocument(input, options) {
-  const { selectedDocs, docsDir, translateLanguages, locale } = input;
-
-  if (!Array.isArray(selectedDocs) || selectedDocs.length === 0) {
-    return {};
-  }
-
-  // Record history if feedback is provided
-  const doc = selectedDocs[0];
-  if (doc.feedback?.trim()) {
-    recordUpdate({
-      operation: "document_update",
-      feedback: doc.feedback.trim(),
-      docPaths: selectedDocs.map((v) => v.path),
-    });
-  }
-
-  // Only prompt user if translation is actually needed
-  let shouldTranslate = false;
-  if (
-    Array.isArray(translateLanguages) &&
-    translateLanguages.filter((lang) => lang !== locale).length > 0
-  ) {
-    const choice = await options.prompts.select({
-      message: "Document update completed. Would you like to translate these documents now?",
-      choices: [
-        {
-          name: "Review documents first, translate later",
-          value: "no",
-        },
-        {
-          name: "Translate now",
-          value: "yes",
-        },
-      ],
-    });
-    shouldTranslate = choice === "yes";
-  }
-
-  // Save documents in batches
-  const batchSize = 3;
-
-  // Return results if user chose to skip translation
-  if (!shouldTranslate) {
-    return {};
-  }
-
-  // Translate documents in batches
-  const translateAgent = options.context.agents["translateMultilingual"];
-
-  await pMap(
-    selectedDocs,
-    async (doc) => {
-      try {
-        // Clear feedback to ensure translation is not affected by update feedback
-        doc.feedback = "";
-
-        await options.context.invoke(translateAgent, {
-          ...input, // context is required
-          content: doc.content,
-          title: doc.title,
-          path: doc.path,
-          docsDir,
-        });
-      } catch (error) {
-        console.error(`❌ Failed to translate document ${doc.path}:`, error.message);
-      }
-    },
-    { concurrency: batchSize },
-  );
-
-  return {};
-}

package/agents/update/sync-images-and-exit.mjs

@@ -1,148 +0,0 @@
-import { syncDiagramToTranslations } from "../../utils/sync-diagram-to-translations.mjs";
-import { readFileContent } from "../../utils/docs-finder-utils.mjs";
-import { getFileName } from "../../utils/utils.mjs";
-import { debug } from "../../utils/debug.mjs";
-
-/**
- * Sync images to translations and exit if shouldSyncImages is true
- * Otherwise, passes through input for normal update flow
- *
- * This agent combines:
- * - Image synchronization logic
- * - Flow routing (sync vs normal update)
- * - Early exit handling
- */
-export default async function syncImagesAndExit(input, options) {
-  // If shouldSyncImages is false, pass through for normal update flow
-  if (!input.shouldSyncImages) {
-    return input;
-  }
-
-  // Sync images flow
-  const { selectedDocs = [], docsDir, locale = "en" } = input;
-
-  if (!docsDir) {
-    throw new Error("docsDir is required for image sync. Please ensure config is loaded.");
-  }
-
-  if (!Array.isArray(selectedDocs) || selectedDocs.length === 0) {
-    const actionSuccessAgent = options.context?.agents?.["actionSuccess"];
-    if (actionSuccessAgent) {
-      await options.context.invoke(actionSuccessAgent, {
-        action: "ℹ️  No documents selected for image sync",
-      });
-    }
-    // Exit normally to prevent passing to next steps
-    process.exit(0);
-  }
-
-  const results = {
-    updated: 0,
-    skipped: 0,
-    errors: [],
-  };
-
-  // Process each document
-  for (const doc of selectedDocs) {
-    try {
-      // Use content from doc if available, otherwise read from file
-      let mainContent = doc.content;
-      if (!mainContent) {
-        const mainFileName = getFileName(doc.path, locale);
-        mainContent = await readFileContent(docsDir, mainFileName);
-      }
-
-      if (!mainContent) {
-        debug(`⚠️  Could not read main document: ${doc.path}`);
-        results.skipped++;
-        continue;
-      }
-
-      // Sync images to translation documents
-      const syncResult = await syncDiagramToTranslations(mainContent, doc.path, docsDir, locale);
-
-      results.updated += syncResult.updated;
-      results.skipped += syncResult.skipped;
-      results.errors.push(...syncResult.errors);
-
-      if (syncResult.updated > 0) {
-        debug(`✅ Synced images from ${doc.path} to ${syncResult.updated} translation file(s)`);
-      } else if (syncResult.skipped > 0) {
-        debug(
-          `⏭️  No changes needed for ${doc.path} (${syncResult.skipped} translation file(s) already in sync)`,
-        );
-      }
-    } catch (error) {
-      debug(`❌ Error syncing images for ${doc.path}: ${error.message}`);
-      results.errors.push({
-        doc: doc.path,
-        error: error.message,
-      });
-    }
-  }
-
-  // Generate success message
-  const message = `✅ Image sync completed: ${results.updated} translation file(s) updated, ${results.skipped} skipped${
-    results.errors.length > 0 ? `, ${results.errors.length} error(s)` : ""
-  }`;
-
-  // Show success message
-  const actionSuccessAgent = options.context?.agents?.["actionSuccess"];
-  if (actionSuccessAgent) {
-    await options.context.invoke(actionSuccessAgent, {
-      action: message,
-    });
-  }
-
-  // Exit normally to prevent passing to next steps and avoid validation errors
-  // This ensures a clean exit after successful image sync
-  process.exit(0);
-}
-
-syncImagesAndExit.input_schema = {
-  type: "object",
-  properties: {
-    shouldSyncImages: {
-      type: "boolean",
-      description: "Whether to trigger image sync to translations",
-    },
-    selectedDocs: {
-      type: "array",
-      description: "Array of selected documents to sync images from",
-    },
-    docsDir: {
-      type: "string",
-      description: "Documentation directory where documents are stored",
-    },
-    locale: {
-      type: "string",
-      description: "Main language locale (e.g., 'en', 'zh')",
-      default: "en",
-    },
-  },
-  required: ["shouldSyncImages"],
-};
-
-syncImagesAndExit.output_schema = {
-  type: "object",
-  properties: {
-    message: {
-      type: "string",
-      description: "Summary message of the sync operation",
-    },
-    updated: {
-      type: "number",
-      description: "Number of translation files successfully updated",
-    },
-    skipped: {
-      type: "number",
-      description: "Number of translation files skipped (no changes needed)",
-    },
-    errors: {
-      type: "array",
-      description: "Array of errors encountered during sync",
-    },
-  },
-};
-
-syncImagesAndExit.task_render_mode = "hide";

package/agents/update/update-document-detail.yaml

@@ -1,71 +0,0 @@
-type: team
-name: updateDocumentDetail
-description: Update and optimize document content based on user feedback using diff patches
-task_render_mode: collapse
-skills:
-  - url: ../utils/analyze-document-feedback-intent.yaml
-  - type: ai
-    instructions:
-      - role: system
-        url: ../../prompts/detail/update/system-prompt.md
-      - role: user
-        url: ../../prompts/detail/update/user-prompt.md
-    auto_reorder_system_messages: true
-    auto_merge_system_messages: true
-    input_schema:
-      type: object
-      properties:
-        originalContent:
-          type: string
-          description: Original markdown content to be updated
-        feedback:
-          type: string
-          description: User feedback for content improvements
-        rules:
-          type: string
-          description: User configuration rules
-        locale:
-          type: string
-          description: User language, e.g. zh, en
-        detailDataSource:
-          type: string
-          description: Context for document content
-        glossary:
-          type: string
-          description: Glossary of terms
-        userPreferences:
-          type: string
-          description: User's saved preferences for content and documentation style
-        targetAudience:
-          type: string
-          description: Target audience for the documentation
-        title:
-          type: string
-          description: Document title
-        description:
-          type: string
-          description: Document description
-        needDataSources:
-          type: boolean
-          description: Whether data sources are needed for content modifications
-        path:
-          type: string
-          description: Document path
-      required:
-        - originalContent
-        - feedback
-        - path
-    output_key: message
-    afs:
-      modules:
-        - module: system-fs
-          options:
-            name: sources
-            localPath: .
-            description: |
-              Codebase of the project to be documented used as context for document generation,
-              should search and read as needed while generating document content
-    keep_text_in_tool_uses: false
-    skills:
-      - ./document-tools/update-document-content.mjs
-      # - ./generate-diagram.yaml