@aigne/doc-smith 0.2.9 → 0.2.11

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.2.11](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.10...v0.2.11) (2025-08-15)
+
+
+### Bug Fixes
+
+* switch default model ([#43](https://github.com/AIGNE-io/aigne-doc-smith/issues/43)) ([203e280](https://github.com/AIGNE-io/aigne-doc-smith/commit/203e280b07d3856445b1877469ed4198db56f6f3))
+
+## [0.2.10](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.9...v0.2.10) (2025-08-14)
+
+
+### Bug Fixes
+
+* fix bug bush feedback ([#41](https://github.com/AIGNE-io/aigne-doc-smith/issues/41)) ([2740d1a](https://github.com/AIGNE-io/aigne-doc-smith/commit/2740d1abef70ea36780b030917a6d54f74df4327))
+
 ## [0.2.9](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.8...v0.2.9) (2025-08-13)
 
 

package/agents/check-detail.mjs

@@ -16,7 +16,6 @@ export default async function checkDetail(
     originalStructurePlan,
     structurePlan,
     modifiedFiles,
-    lastGitHead,
     forceRegenerate,
     ...rest
   },
@@ -80,11 +79,6 @@ export default async function checkDetail(
     }
   }
 
-  // If lastGitHead is not set, regenerate
-  if (!lastGitHead) {
-    sourceFilesChanged = true;
-  }
-
   // If file exists, check content validation
   let contentValidationFailed = false;
   if (detailGenerated && fileContent && structurePlan) {

package/agents/check-structure-plan.mjs

@@ -1,3 +1,5 @@
+import { access } from "node:fs/promises";
+import { join } from "node:path";
 import {
   getCurrentGitHead,
   getProjectInfo,
@@ -7,7 +9,7 @@ import {
 } from "../utils/utils.mjs";
 
 export default async function checkStructurePlan(
-  { originalStructurePlan, feedback, lastGitHead, ...rest },
+  { originalStructurePlan, feedback, lastGitHead, docsDir, forceRegenerate, ...rest },
   options,
 ) {
   // Check if we need to regenerate structure plan
@@ -16,9 +18,18 @@ export default async function checkStructurePlan(
 
   // If no feedback and originalStructurePlan exists, check for git changes
   if (originalStructurePlan) {
-    // If no lastGitHead, regenerate by default
+    // If no lastGitHead, check if _sidebar.md exists to determine if we should regenerate
     if (!lastGitHead) {
-      shouldRegenerate = true;
+      try {
+        // Check if _sidebar.md exists in docsDir
+        const sidebarPath = join(docsDir, "_sidebar.md");
+        await access(sidebarPath);
+        // If _sidebar.md exists, it means last execution was completed, need to regenerate
+        shouldRegenerate = true;
+      } catch {
+        // If _sidebar.md doesn't exist, it means last execution was interrupted, no need to regenerate
+        shouldRegenerate = false;
+      }
     } else {
       // Check if there are relevant file changes since last generation
       const currentGitHead = getCurrentGitHead();
@@ -43,6 +54,16 @@ export default async function checkStructurePlan(
     }
   }
 
+  // user requested regeneration
+  if (forceRegenerate) {
+    shouldRegenerate = true;
+    finalFeedback = `
+    ${finalFeedback || ""}
+
+    用户请求强制重新生成结构规划，请根据最新的 Data Sources 和用户要求重生生成，**允许任何修改**。
+    `;
+  }
+
   // If no regeneration needed, return original structure plan
   if (originalStructurePlan && !feedback && !shouldRegenerate) {
     return {

package/agents/load-config.mjs

@@ -2,7 +2,7 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import { parse } from "yaml";
 
-export default async function loadConfig({ config }) {
+export default async function loadConfig({ config, appUrl }) {
   const configPath = path.join(process.cwd(), config);
 
   try {
@@ -18,6 +18,11 @@ export default async function loadConfig({ config }) {
     // Read and parse YAML file
     const configContent = await fs.readFile(configPath, "utf-8");
     const parsedConfig = parse(configContent);
+
+    if (appUrl) {
+      parsedConfig.appUrl = appUrl;
+    }
+
     return {
       nodeName: "Section",
       locale: "en",
@@ -40,5 +45,9 @@ loadConfig.input_schema = {
       type: "string",
       default: "./.aigne/doc-smith/config.yaml",
     },
+    appUrl: {
+      type: "string",
+      description: "Application URL to override config",
+    },
   },
 };

package/agents/load-sources.mjs

@@ -174,8 +174,8 @@ export default async function loadSources({
       const words = source.match(/[a-zA-Z]+/g) || [];
       totalWords += words.length;
 
-      // Count lines
-      totalLines += source.split("\n").length;
+      // Count lines (excluding empty lines)
+      totalLines += source.split("\n").filter((line) => line.trim() !== "").length;
     }
   }
 

package/agents/publish-docs.mjs

@@ -1,95 +1,10 @@
-import { existsSync, mkdirSync } from "node:fs";
-import { readFile, writeFile } from "node:fs/promises";
-import { homedir } from "node:os";
 import { basename, join } from "node:path";
-import { createConnect } from "@aigne/aigne-hub";
 import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
-import open from "open";
-import { joinURL } from "ufo";
-import { parse, stringify } from "yaml";
+import { getAccessToken } from "../utils/auth-utils.mjs";
 import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
 
-const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
 const DEFAULT_APP_URL = "https://docsmith.aigne.io";
 
-/**
- * Get access token from environment, config file, or prompt user for authorization
- * @param {string} appUrl - The application URL
- * @returns {Promise<string>} - The access token
- */
-async function getAccessToken(appUrl) {
-  const DOC_SMITH_ENV_FILE = join(homedir(), ".aigne", "doc-smith-connected.yaml");
-  const { hostname } = new URL(appUrl);
-
-  let accessToken = process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN;
-
-  // Check if access token exists in environment or config file
-  if (!accessToken) {
-    try {
-      if (existsSync(DOC_SMITH_ENV_FILE)) {
-        const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
-        if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
-          const envs = parse(data);
-          if (envs[hostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
-            accessToken = envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
-          }
-        }
-      }
-    } catch (error) {
-      console.warn("Failed to read config file:", error.message);
-    }
-  }
-
-  // If still no access token, prompt user to authorize
-  if (!accessToken) {
-    const DISCUSS_KIT_URL = appUrl;
-    const connectUrl = joinURL(new URL(DISCUSS_KIT_URL).origin, WELLKNOWN_SERVICE_PATH_PREFIX);
-
-    try {
-      const result = await createConnect({
-        connectUrl: connectUrl,
-        connectAction: "gen-simple-access-key",
-        source: `AIGNE DocSmith connect to Discuss Kit`,
-        closeOnSuccess: true,
-        appName: "AIGNE DocSmith",
-        appLogo: "https://www.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
-        openPage: (pageUrl) => open(pageUrl),
-      });
-
-      accessToken = result.accessKeySecret;
-      process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN = accessToken;
-
-      // Save the access token to config file
-      const aigneDir = join(homedir(), ".aigne");
-      if (!existsSync(aigneDir)) {
-        mkdirSync(aigneDir, { recursive: true });
-      }
-
-      const existingConfig = existsSync(DOC_SMITH_ENV_FILE)
-        ? parse(await readFile(DOC_SMITH_ENV_FILE, "utf8"))
-        : {};
-
-      await writeFile(
-        DOC_SMITH_ENV_FILE,
-        stringify({
-          ...existingConfig,
-          [hostname]: {
-            DOC_DISCUSS_KIT_ACCESS_TOKEN: accessToken,
-            DOC_DISCUSS_KIT_URL: DISCUSS_KIT_URL,
-          },
-        }),
-      );
-    } catch (error) {
-      console.error("Failed to get access token:", error);
-      throw new Error(
-        "Failed to obtain access token. Please check your network connection and try again later.",
-      );
-    }
-  }
-
-  return accessToken;
-}
-
 export default async function publishDocs(
   { docsDir, appUrl, boardId, projectName, projectDesc, projectLogo },
   options,
@@ -124,17 +39,21 @@ export default async function publishDocs(
     });
 
     if (choice === "custom") {
-      appUrl = await options.prompts.input({
+      const userInput = await options.prompts.input({
         message: "Please enter your Discuss Kit platform URL:",
         validate: (input) => {
           try {
-            new URL(input);
+            // Check if input contains protocol, if not, prepend https://
+            const urlWithProtocol = input.includes("://") ? input : `https://${input}`;
+            new URL(urlWithProtocol);
             return true;
           } catch {
             return "Please enter a valid URL";
           }
         },
       });
+      // Ensure appUrl has protocol
+      appUrl = userInput.includes("://") ? userInput : `https://${userInput}`;
     }
   }
 

package/agents/team-publish-docs.yaml

@@ -10,10 +10,9 @@ skills:
       skipIfExists: true
   - load-config.mjs
   - publish-docs.mjs
-# input_schema:
-#   type: object
-#   properties:
-#     config:
-#       type: string
-#       description: Path to the config file
-#       default: ./.aigne/doc-smith/config.yaml
+input_schema:
+  type: object
+  properties:
+    appUrl: 
+      type: string
+      description: target website URL where the documentation will be published

package/aigne.yaml

@@ -2,8 +2,8 @@
 
 chat_model:
   provider: google
-  # name: gemini-2.5-pro
-  name: gemini-2.5-flash
+  name: gemini-2.5-pro
+  # name: gemini-2.5-flash
   temperature: 0.8
 agents:
   - ./agents/structure-planning.yaml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "",
   "publishConfig": {
     "access": "public"

package/utils/auth-utils.mjs

@@ -0,0 +1,105 @@
+import { existsSync, mkdirSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { createConnect } from "@aigne/aigne-hub";
+import open from "open";
+import { joinURL } from "ufo";
+import { parse, stringify } from "yaml";
+import { getComponentMountPoint } from "./blocklet.mjs";
+import { DISCUSS_KIT_DID } from "./constants.mjs";
+
+const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
+
+/**
+ * Get access token from environment, config file, or prompt user for authorization
+ * @param {string} appUrl - The application URL
+ * @returns {Promise<string>} - The access token
+ */
+export async function getAccessToken(appUrl) {
+  const DOC_SMITH_ENV_FILE = join(homedir(), ".aigne", "doc-smith-connected.yaml");
+  const { hostname } = new URL(appUrl);
+
+  let accessToken = process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN;
+
+  // Check if access token exists in environment or config file
+  if (!accessToken) {
+    try {
+      if (existsSync(DOC_SMITH_ENV_FILE)) {
+        const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
+        if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
+          const envs = parse(data);
+          if (envs[hostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
+            accessToken = envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
+          }
+        }
+      }
+    } catch (error) {
+      console.warn("Failed to read config file:", error.message);
+    }
+  }
+
+  // If still no access token, prompt user to authorize
+  if (accessToken) {
+    return accessToken;
+  }
+
+  // Check if Discuss Kit is running at the provided URL
+  try {
+    await getComponentMountPoint(appUrl, DISCUSS_KIT_DID);
+  } catch {
+    throw new Error(
+      `Unable to find Discuss Kit running at the provided URL: ${appUrl}\n\n` +
+        "Please ensure that:\n" +
+        "• The URL is correct and accessible\n" +
+        "• Discuss Kit is properly installed and running\n" +
+        "If you continue to experience issues, please verify your Discuss Kit installation.",
+    );
+  }
+
+  const DISCUSS_KIT_URL = appUrl;
+  const connectUrl = joinURL(new URL(DISCUSS_KIT_URL).origin, WELLKNOWN_SERVICE_PATH_PREFIX);
+
+  try {
+    const result = await createConnect({
+      connectUrl: connectUrl,
+      connectAction: "gen-simple-access-key",
+      source: `AIGNE DocSmith connect to Discuss Kit`,
+      closeOnSuccess: true,
+      appName: "AIGNE DocSmith",
+      appLogo: "https://www.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
+      openPage: (pageUrl) => open(pageUrl),
+    });
+
+    accessToken = result.accessKeySecret;
+    process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN = accessToken;
+
+    // Save the access token to config file
+    const aigneDir = join(homedir(), ".aigne");
+    if (!existsSync(aigneDir)) {
+      mkdirSync(aigneDir, { recursive: true });
+    }
+
+    const existingConfig = existsSync(DOC_SMITH_ENV_FILE)
+      ? parse(await readFile(DOC_SMITH_ENV_FILE, "utf8"))
+      : {};
+
+    await writeFile(
+      DOC_SMITH_ENV_FILE,
+      stringify({
+        ...existingConfig,
+        [hostname]: {
+          DOC_DISCUSS_KIT_ACCESS_TOKEN: accessToken,
+          DOC_DISCUSS_KIT_URL: DISCUSS_KIT_URL,
+        },
+      }),
+    );
+  } catch (error) {
+    console.debug(error);
+    throw new Error(
+      "Failed to obtain access token. Please check your network connection and try again later.",
+    );
+  }
+
+  return accessToken;
+}

package/utils/blocklet.mjs

@@ -0,0 +1,25 @@
+export async function getComponentMountPoint(appUrl, did) {
+  const url = new URL(appUrl);
+  const blockletJsUrl = `${url.origin}/__blocklet__.js?type=json`;
+
+  const blockletJs = await fetch(blockletJsUrl, {
+    method: "GET",
+    headers: {
+      Accept: "application/json",
+    },
+  });
+
+  if (!blockletJs.ok) {
+    throw new Error(
+      `Failed to fetch blocklet json: ${blockletJs.status} ${blockletJs.statusText}, ${blockletJsUrl}`,
+    );
+  }
+
+  const config = await blockletJs.json();
+  const component = config.componentMountPoints.find((component) => component.did === did);
+  if (!component) {
+    throw new Error(`Component ${did} not found in blocklet: ${appUrl}`);
+  }
+
+  return component.mountPoint;
+}

package/utils/constants.mjs

@@ -1,25 +1,89 @@
 // Default file patterns for inclusion and exclusion
 export const DEFAULT_INCLUDE_PATTERNS = [
+  // Python
   "*.py",
+  "*.pyi",
+  "*.pyx",
+  // JavaScript/TypeScript
   "*.js",
   "*.jsx",
   "*.ts",
   "*.tsx",
-  "*.go",
-  "*.java",
-  "*.pyi",
-  "*.pyx",
+  // C/C++
   "*.c",
   "*.cc",
   "*.cpp",
+  "*.cxx",
+  "*.c++",
   "*.h",
+  "*.hpp",
+  "*.hxx",
+  "*.h++",
+  // JVM Languages
+  "*.java",
+  "*.kt",
+  "*.scala",
+  "*.groovy",
+  "*.gvy",
+  "*.gy",
+  "*.gsh",
+  "*.clj",
+  "*.cljs",
+  "*.cljx",
+  // .NET Languages
+  "*.cs",
+  "*.vb",
+  "*.fs",
+  // Functional Languages
+  "*.f",
+  "*.ml",
+  "*.sml",
+  "*.lisp",
+  "*.lsp",
+  "*.cl",
+  // Systems Programming
+  "*.rs",
+  "*.go",
+  "*.nim",
+  "*.asm",
+  "*.s",
+  // Web Technologies
+  "*.html",
+  "*.htm",
+  "*.css",
+  "*.php",
+  // Scripting Languages
+  "*.rb",
+  "*.pl",
+  "*.ps1",
+  "*.lua",
+  "*.tcl",
+  // Mobile/Modern Languages
+  "*.swift",
+  "*.dart",
+  "*.ex",
+  "*.exs",
+  "*.erl",
+  "*.jl",
+  // Data Science
+  "*.r",
+  "*.R",
+  "*.m",
+  // Other Languages
+  "*.pas",
+  "*.cob",
+  "*.cbl",
+  "*.pro",
+  "*.prolog",
+  "*.sql",
+  // Documentation & Config
   "*.md",
   "*.rst",
   "*.json",
-  "*Dockerfile",
-  "*Makefile",
   "*.yaml",
   "*.yml",
+  "*Dockerfile",
+  "*Makefile",
 ];
 
 export const DEFAULT_EXCLUDE_PATTERNS = [
@@ -78,14 +142,14 @@ export const SUPPORTED_LANGUAGES = [
 
 // Predefined document generation styles
 export const DOCUMENT_STYLES = {
-  developerDocs: {
-    name: "Developer Docs",
-    rules: "Steps-first; copy-paste examples; minimal context; active 'you'.",
-  },
   userGuide: {
     name: "User Guide",
     rules: "Scenario-based; step-by-step; plain language; outcomes & cautions.",
   },
+  developerDocs: {
+    name: "Developer Docs",
+    rules: "Steps-first; copy-paste examples; minimal context; active 'you'.",
+  },
   apiReference: {
     name: "API Reference",
     rules: "Exact & skimmable; schema-first; clear params/errors/examples.",
@@ -98,8 +162,11 @@ export const DOCUMENT_STYLES = {
 
 // Predefined target audiences
 export const TARGET_AUDIENCES = {
+  generalUsers: "General Users",
   actionFirst: "Developers, Implementation Engineers, DevOps",
   conceptFirst: "Architects, Technical Leads, Developers interested in principles",
-  generalUsers: "General Users",
   custom: "Enter your own target audience",
 };
+
+// Component mount point ID for Discuss Kit
+export const DISCUSS_KIT_DID = "z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu";

package/utils/file-utils.mjs

@@ -1,5 +1,5 @@
-import { access, readFile } from "node:fs/promises";
 import { execSync } from "node:child_process";
+import { access, readFile } from "node:fs/promises";
 import path from "node:path";
 import { glob } from "glob";
 

package/utils/markdown-checker.mjs

@@ -91,45 +91,34 @@ function checkDeadLinks(markdown, source, allowedLinks, errorMessages) {
 /**
  * Check code block content for indentation consistency issues
  * @param {Array} codeBlockContent - Array of {line, lineNumber} objects from the code block
+ * @param {number} codeBlockIndent - The indentation of the code block start marker (```)
  * @param {string} source - Source description for error reporting
  * @param {Array} errorMessages - Array to push error messages to
  */
-function checkCodeBlockIndentation(codeBlockContent, source, errorMessages) {
+function checkCodeBlockIndentation(codeBlockContent, codeBlockIndent, source, errorMessages) {
   if (codeBlockContent.length === 0) return;
 
-  // Filter out empty lines for base indentation calculation
+  // Filter out empty lines for analysis
   const nonEmptyLines = codeBlockContent.filter((item) => item.line.trim().length > 0);
   if (nonEmptyLines.length === 0) return;
 
-  // Find the base indentation from the first meaningful line
-  let baseCodeIndent = null;
+  // The expected base indentation for code block content should match the code block marker
+  const expectedBaseIndent = codeBlockIndent;
   const problematicLines = [];
 
   for (const item of nonEmptyLines) {
     const { line, lineNumber } = item;
     const match = line.match(/^(\s*)/);
     const currentIndent = match ? match[1].length : 0;
-    const trimmedLine = line.trim();
 
-    // Skip lines that are clearly comments (common pattern: # comment)
-    if (trimmedLine.startsWith("#") && !trimmedLine.includes("=") && !trimmedLine.includes("{")) {
-      continue;
-    }
-
-    // Establish base indentation from the first meaningful line
-    if (baseCodeIndent === null) {
-      baseCodeIndent = currentIndent;
-      continue;
-    }
-
-    // Check if current line has less indentation than the base
+    // Check if current line has less indentation than expected
     // This indicates inconsistent indentation that may cause rendering issues
-    if (currentIndent < baseCodeIndent && baseCodeIndent > 0) {
+    if (currentIndent < expectedBaseIndent && expectedBaseIndent > 0) {
       problematicLines.push({
         lineNumber,
         line: line.trimEnd(),
         currentIndent,
-        baseIndent: baseCodeIndent,
+        expectedIndent: expectedBaseIndent,
       });
     }
   }
@@ -162,7 +151,7 @@ function checkCodeBlockIndentation(codeBlockContent, source, errorMessages) {
           ? `lines ${group[0].lineNumber}-${group[group.length - 1].lineNumber}`
           : `line ${firstIssue.lineNumber}`;
 
-      const issue = `inconsistent indentation: ${firstIssue.currentIndent} spaces (base: ${firstIssue.baseIndent} spaces)`;
+      const issue = `insufficient indentation: ${firstIssue.currentIndent} spaces (expected: ${firstIssue.expectedIndent} spaces)`;
       errorMessages.push(
         `Found code block with inconsistent indentation in ${source} at ${lineNumbers}: ${issue}. This may cause rendering issues`,
       );
@@ -185,6 +174,7 @@ function checkContentStructure(markdown, source, errorMessages) {
   let inAnyCodeBlock = false;
   let anyCodeBlockStartLine = 0;
   let codeBlockContent = [];
+  let codeBlockIndent = 0;
 
   for (let i = 0; i < lines.length; i++) {
     const line = lines[i];
@@ -198,13 +188,17 @@ function checkContentStructure(markdown, source, errorMessages) {
         anyCodeBlockStartLine = lineNumber;
         inCodeBlock = true;
         codeBlockContent = [];
+
+        // Capture the indentation of the code block start marker
+        const match = line.match(/^(\s*)/);
+        codeBlockIndent = match ? match[1].length : 0;
       } else {
         // Ending the code block
         inAnyCodeBlock = false;
 
         if (inCodeBlock) {
           // Check code block content for indentation issues
-          checkCodeBlockIndentation(codeBlockContent, source, errorMessages);
+          checkCodeBlockIndentation(codeBlockContent, codeBlockIndent, source, errorMessages);
           inCodeBlock = false;
         }
       }