@aigne/doc-smith 0.8.15-beta.12 → 0.8.15-beta.14

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [0.8.15-beta.14](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.13...v0.8.15-beta.14) (2025-11-06)
+
+
+### Features
+
+* add reasoning effort configuration for customizable AI model settings ([#270](https://github.com/AIGNE-io/aigne-doc-smith/issues/270)) ([9f15638](https://github.com/AIGNE-io/aigne-doc-smith/commit/9f156387120e8705bf16cf611d7f8f39995c36b3))
+* **cli:** enhance auth with short link responses and detailed error reporting for publishing ([#269](https://github.com/AIGNE-io/aigne-doc-smith/issues/269)) ([31cc252](https://github.com/AIGNE-io/aigne-doc-smith/commit/31cc25236667236dfe91543acdd7e8cccff659c5))
+
+
+### Bug Fixes
+
+* use default reasoning effort for existing config ([#272](https://github.com/AIGNE-io/aigne-doc-smith/issues/272)) ([2fc9c89](https://github.com/AIGNE-io/aigne-doc-smith/commit/2fc9c89e383c1c5446f2109a2846e831d1e1e871))
+
+## [0.8.15-beta.13](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.12...v0.8.15-beta.13) (2025-11-05)
+
+
+### Bug Fixes
+
+* make paid deployment more smooth stable ([#266](https://github.com/AIGNE-io/aigne-doc-smith/issues/266)) ([ce8c00a](https://github.com/AIGNE-io/aigne-doc-smith/commit/ce8c00ab3eb045c482e07dc3c4e3bd149e754a06))
+* validate docsDir on init and ensure latest doc on view after publish ([#267](https://github.com/AIGNE-io/aigne-doc-smith/issues/267)) ([e45864d](https://github.com/AIGNE-io/aigne-doc-smith/commit/e45864da4a7fb5b09af2bbffdb7ca93abd74397c))
+
 ## [0.8.15-beta.12](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.11...v0.8.15-beta.12) (2025-11-05)
 
 

package/agents/generate/generate-structure.yaml

@@ -7,8 +7,6 @@ skills:
     iterate_on: dataSources
     skills:
       - type: ai
-        model:
-          reasoning_effort: 500
         instructions:
           - role: system
             url: ../../prompts/structure/generate/system-prompt.md
@@ -82,8 +80,6 @@ skills:
 
   - type: ai
     name: refineStructure
-    model:
-      reasoning_effort: 500
     instructions:
       - role: system
         url: ../../prompts/structure/review/structure-review-system.md

package/agents/init/index.mjs

@@ -21,9 +21,12 @@ import {
   validatePath,
 } from "../../utils/utils.mjs";
 import { isRemoteFile } from "../../utils/file-utils.mjs";
+import { validateDocDir } from "./validate.mjs";
 
 const _PRESS_ENTER_TO_FINISH = "Press Enter to finish";
 
+const DEFAULT_REASONING_EFFORT = 502;
+
 /**
  * Guides the user through a multi-turn dialog to generate a YAML configuration file.
  * @param {Object} params
@@ -31,7 +34,15 @@ const _PRESS_ENTER_TO_FINISH = "Press Enter to finish";
  * @param {string} params.fileName - The name of the file.
  * @returns {Promise<Object>}
  */
-export default async function init(
+export default async function init(input, options) {
+  const config = await _init(input, options);
+
+  options.context.userContext.reasoningEffort = config.reasoningEffort || DEFAULT_REASONING_EFFORT;
+
+  return config;
+}
+
+async function _init(
   {
     outputPath = ".aigne/doc-smith",
     fileName = "config.yaml",
@@ -64,7 +75,19 @@ export default async function init(
     // Only skip if file exists AND has non-empty content
     if (configContent && configContent.trim() !== "") {
       // load config from file
-      return loadConfig({ config: filePath, appUrl });
+      const config = await loadConfig({ config: filePath, appUrl });
+      const isValid = validateDocDir(config.docsDir);
+      if (typeof isValid === "string") {
+        console.log(
+          `${chalk.red("Invalid docsDir")}: ${isValid}\nPlease check your configuration.`,
+        );
+        process.exit(1);
+      }
+      if (!isValid) {
+        console.log(`${chalk.red("Invalid docsDir")}, please check your configuration.`);
+        process.exit(1);
+      }
+      return config;
     }
   }
 
@@ -241,6 +264,7 @@ export default async function init(
   const docsDirInput = await options.prompts.input({
     message: `📁 [7/9]: Where should we save your documentation?`,
     default: `${outputPath}/docs`,
+    validate: validateDocDir,
   });
   input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
 
@@ -374,6 +398,8 @@ export default async function init(
   input.projectDesc = projectInfo.description;
   input.projectLogo = projectInfo.icon;
 
+  input.reasoningEffort = DEFAULT_REASONING_EFFORT;
+
   // Generate YAML content
   const yamlContent = generateYAML(input, outputPath);
 
@@ -424,6 +450,8 @@ export function generateYAML(input) {
     projectDesc: input.projectDesc || "",
     projectLogo: input.projectLogo || "",
 
+    reasoningEffort: input.reasoningEffort || 502,
+
     // Documentation configuration
     documentPurpose: input.documentPurpose || [],
     targetAudienceTypes: input.targetAudienceTypes || [],
@@ -459,6 +487,18 @@ export function generateYAML(input) {
 
   yaml += `${projectSection}\n\n`;
 
+  const modelSection = yamlStringify({
+    reasoningEffort: config.reasoningEffort,
+  }).trim();
+
+  yaml += `\
+# Model Configuration
+
+# Reasoning Effort: Level of reasoning effort for AI model, lower is faster but less thorough.
+# Options: minimal, low, medium, high, or numeric values 128-32768.
+${modelSection}
+\n`;
+
   // Add documentation configuration with comments
   yaml += "# =============================================================================\n";
   yaml += "# Documentation Configuration\n";

package/agents/init/validate.mjs

@@ -0,0 +1,16 @@
+import path from "node:path";
+export function validateDocDir(input) {
+  const currentDir = process.cwd();
+  const targetDir = path.resolve(input);
+  const relativePath = path.relative(currentDir, targetDir);
+  if (relativePath.length === 0) {
+    return `Can't use current directory: ${targetDir}`;
+  }
+  if (relativePath.startsWith("..")) {
+    return `Can't use directory outside current directory: ${targetDir}`;
+  }
+  if (path.isAbsolute(relativePath)) {
+    return `Can't use absolute path: ${targetDir}`;
+  }
+  return true;
+}

package/agents/publish/publish-docs.mjs

@@ -163,8 +163,13 @@ export default async function publishDocs(
           } else {
             console.log(`\nCreating a new website for your documentation...`);
           }
-          const { appUrl: homeUrl, token: ltToken } = (await deploy(id, paymentLink)) || {};
+          const {
+            appUrl: homeUrl,
+            token: ltToken,
+            sessionId: newSessionId,
+          } = (await deploy(id, paymentLink)) || {};
 
+          sessionId = newSessionId;
           appUrl = homeUrl;
           token = ltToken;
         } catch (error) {
@@ -174,13 +179,7 @@ export default async function publishDocs(
       }
     }
 
-    if (sessionId) {
-      authToken = await getOfficialAccessToken(BASE_URL, false);
-      client = client || new BrokerClient({ baseUrl: BASE_URL, authToken });
-
-      const { vendors } = await client.getSessionDetail(sessionId, false);
-      token = vendors?.find((vendor) => vendor.vendorType === "launcher" && vendor.token)?.token;
-    }
+    appUrl = appUrl ?? CLOUD_SERVICE_URL_PROD;
 
     console.log(`\nPublishing your documentation to ${chalk.cyan(appUrl)}\n`);
 
@@ -264,8 +263,15 @@ export default async function publishDocs(
       await saveValueToConfig("shouldSyncBranding", "", "Should sync branding for documentation");
     } else {
       // If the error is 401 or 403, it means the access token is invalid
-      if (error?.includes("401") || error?.includes("403")) {
-        message = `❌ Publishing failed due to an authorization error. Please run ${chalk.cyan("aigne doc clear")} to reset your credentials and try again.`;
+      try {
+        const obj = JSON.parse(error);
+        message = `❌ Publishing failed with error: \n💡 ${obj.message || error}`;
+      } catch {
+        if (error?.includes("401")) {
+          message = `❌ Publishing failed due to an authorization error: \n💡 Please run ${chalk.cyan("aigne doc clear")} to reset your credentials and try again.`;
+        } else if (error?.includes("403")) {
+          message = `❌ Publishing failed due to an authorization error: \n💡 You’re not the creator of this document (Board ID: ${boardId}). You can change the board ID and try again. \n💡  Or run ${chalk.cyan("aigne doc clear")} to reset your credentials and try again.`;
+        }
       }
     }
 

package/agents/update/user-review-document.mjs

@@ -208,13 +208,14 @@ export default async function userReviewDocument({ content, description, ...rest
 
     try {
       // Call updateDocument agent with feedback
-      await options.context.invoke(updateAgent, {
+      const result = await options.context.invoke(updateAgent, {
         ...rest,
         originalContent: options.context.userContext.currentContent,
         feedback: feedback.trim(),
         userPreferences,
         title,
       });
+      options.context.userContext.currentContent = result.content;
 
       // Check if feedback should be saved as user preference
       const feedbackRefinerAgent = options.context.agents["checkFeedbackRefiner"];

package/agents/utils/analyze-feedback-intent.yaml

@@ -1,7 +1,5 @@
 name: analyzeFeedbackIntent
 description: Analyze user feedback to determine if data sources are needed for content modifications
-model:
-  reasoning_effort: 200
 task_render_mode: hide
 instructions:
   url: ../../prompts/utils/analyze-feedback-intent.md

package/aigne.yaml

@@ -3,8 +3,8 @@
 model:
   model: aignehub/gemini-2.5-pro # reasoning_effort 128-32768
   # https://github.com/AIGNE-io/aigne-framework/blob/main/models/gemini/src/gemini-chat-model.ts#L115
-  reasoning_effort: 502
-  # name: gemini-2.5-flash
+  reasoning_effort:
+    $get: reasoningEffort
   temperature: 0.8
 agents:
   # Initialization

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.15-beta.12",
+  "version": "0.8.15-beta.14",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
@@ -24,14 +24,14 @@
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "Elastic-2.0",
   "dependencies": {
-    "@aigne/aigne-hub": "^0.10.0",
-    "@aigne/anthropic": "^0.14.0",
-    "@aigne/cli": "^1.49.1",
-    "@aigne/core": "^1.61.0",
-    "@aigne/gemini": "^0.14.0",
-    "@aigne/openai": "^0.16.0",
-    "@aigne/publish-docs": "^0.12.0",
-    "@blocklet/payment-broker-client": "^1.21.10",
+    "@aigne/aigne-hub": "^0.10.5-beta.3",
+    "@aigne/anthropic": "^0.14.5-beta.3",
+    "@aigne/cli": "^1.53.1-beta.4",
+    "@aigne/core": "^1.65.1-beta.3",
+    "@aigne/gemini": "^0.14.5-beta.3",
+    "@aigne/openai": "^0.16.5-beta.3",
+    "@aigne/publish-docs": "^0.12.1",
+    "@blocklet/payment-broker-client": "^1.22.8",
     "@terrastruct/d2": "^0.1.33",
     "chalk": "^5.5.0",
     "cli-highlight": "^2.1.11",

package/prompts/detail/custom/custom-code-block.md

@@ -18,6 +18,11 @@ The following are the available enhanced attributes and their descriptions:
   * `language` and `title` are written directly after \`\`\`, separated by spaces.
   * Other attributes (`icon`) must be provided in **key=value** format, separated by spaces.
 
+### Special Rules
+- If the language is a shell (includes `sh`, `bash`, `zsh`, etc.):
+  - Executable shell code blocks must be a single-line command to make copying and running easier.
+  - Do not include comments inside executable shell code blocks; place explanatory comments outside the code block.
+
 ### Examples
 
 <code_block_good_examples>
@@ -70,9 +75,26 @@ class ShoppingCart {
   }
 }
 ```
+
+**Example 5: Shell code block should in one line**
+
+```sh Install aigne deps icon=lucide:terminal
+npm i -g @aigne/cli @aigne/doc-smith @aigne/websmith-smith
+```
+
+**Example 6: Shell code block use `\` to split multiple lines**
+```bash Deploying with Access Keys icon=lucide:terminal
+blocklet deploy . \
+  --endpoint https://my-server.arcblock.io \
+  --access-key 'your_access_key_id' \
+  --access-secret 'your_access_key_secret' \
+  --app-id z2qa9sD2tFAP8gM7C1i8iETg3a1T3A3aT3bQ
+```
+
 </code_block_good_examples>
 
 <code_block_bad_examples>
+
 **Example 1**
 
 There are two errors in this example:
@@ -97,5 +119,18 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 }
 ```
 
+**Example 2: shell code block have multiple lines**
+```sh
+npm i -g @aigne/cli
+npm i -g @aigne/doc-smith
+npm i -g @aigne/websmith-smith
+```
+
+**Example 3: shell code block comments**
+```sh
+# add aigne deps
+npm i -g @aigne/cli
+```
+
 </code_block_bad_examples>
-</enhanced_code_block_rules>
+</enhanced_code_block_rules>

package/utils/deploy.mjs

@@ -31,6 +31,7 @@ export async function deploy(id, cachedUrl) {
   const result = await client.deploy({
     cachedCheckoutId: id,
     cachedPaymentUrl: cachedUrl,
+    needShortUrl: true,
     pageInfo: { successMessage: SUCCESS_MESSAGE },
     hooks: {
       [STEPS.PAYMENT_PENDING]: async ({ sessionId, paymentUrl, isResuming }) => {
@@ -71,7 +72,7 @@ export async function deploy(id, cachedUrl) {
     },
   });
 
-  const { appUrl, homeUrl, subscriptionUrl, dashboardUrl, vendors } = result;
+  const { appUrl, homeUrl, subscriptionUrl, dashboardUrl, vendors, sessionId } = result;
   const token = vendors?.[0]?.token;
 
   return {
@@ -80,5 +81,6 @@ export async function deploy(id, cachedUrl) {
     dashboardUrl,
     subscriptionUrl,
     token,
+    sessionId,
   };
 }