@aigne/doc-smith 0.8.11-beta.4 → 0.8.11-beta.6

package/.aigne/doc-smith/config.yaml

@@ -66,9 +66,7 @@ translateLanguages:
 docsDir: ./docs  # Directory to save generated documentation
 sourcesPath:  # Source code paths to analyze
   - ./
-lastGitHead: f3f14b93e6b2e6beb42b2f368c2560ab050dfd03
-appUrl: https://docsmith.aigne.io
+lastGitHead: 6fc5d715e778663896ae179975ec72d9e5ff97ed
 # ⚠️ Warning: boardId is auto-generated by system, please do not edit manually
 boardId: "docsmith"
-# Checkout ID for document deployment service
-checkoutId: ""
+appUrl: https://docsmith.aigne.io

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.11-beta.4"
+  ".": "0.8.11-beta.6"
 }

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.8.11-beta.6](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.11-beta.5...v0.8.11-beta.6) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* release 0.8.11-beta.6 ([ecc8f5c](https://github.com/AIGNE-io/aigne-doc-smith/commit/ecc8f5c4ff9cc813e5cf7e35cbfdb915826cd183))
+
+## [0.8.11-beta.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.11-beta.4...v0.8.11-beta.5) (2025-10-01)
+
+
+### Features
+
+* add user role requirement for publish and custom rule support ([#151](https://github.com/AIGNE-io/aigne-doc-smith/issues/151)) ([95866f9](https://github.com/AIGNE-io/aigne-doc-smith/commit/95866f9fcb2ca697da42e950e9011b29913726d4))
+* split d2 diagram generate as independent tool ([#152](https://github.com/AIGNE-io/aigne-doc-smith/issues/152)) ([8e9b811](https://github.com/AIGNE-io/aigne-doc-smith/commit/8e9b811dc6108bb19ab8a1853afb4cab92af1d62))
+
 ## [0.8.11-beta.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.11-beta.3...v0.8.11-beta.4) (2025-09-30)
 
 
@@ -71,7 +86,7 @@
 ### Bug Fixes
 
 * polish code test ([#122](https://github.com/AIGNE-io/aigne-doc-smith/issues/122)) ([0629705](https://github.com/AIGNE-io/aigne-doc-smith/commit/0629705ebd271282411d507421c1ba5dd01473b9))
-* update document structure review prompts and display ([#119](https://github.com/AIGNE-io/aigne-doc-smith/issues/119)) ([e2d99db](https://github.com/AIGNE-io/aigne-doc-smith/commit/e2d99db83ff3a6266b32dd450a79b6e000aff09e))
+* update documentation structure review prompts and display ([#119](https://github.com/AIGNE-io/aigne-doc-smith/issues/119)) ([e2d99db](https://github.com/AIGNE-io/aigne-doc-smith/commit/e2d99db83ff3a6266b32dd450a79b6e000aff09e))
 * update usage rules for field elements ([#120](https://github.com/AIGNE-io/aigne-doc-smith/issues/120)) ([434f161](https://github.com/AIGNE-io/aigne-doc-smith/commit/434f161ab7dd989d57ca670f36d0828c09abe38a))
 
 ## [0.8.10-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.10-beta...v0.8.10-beta.1) (2025-09-18)
@@ -79,7 +94,7 @@
 
 ### Features
 
-* support document structure review workflow ([#117](https://github.com/AIGNE-io/aigne-doc-smith/issues/117)) ([ec7ae80](https://github.com/AIGNE-io/aigne-doc-smith/commit/ec7ae80b26a1b66928bddef7ac401f633a0f5a2b))
+* support documentation structure review workflow ([#117](https://github.com/AIGNE-io/aigne-doc-smith/issues/117)) ([ec7ae80](https://github.com/AIGNE-io/aigne-doc-smith/commit/ec7ae80b26a1b66928bddef7ac401f633a0f5a2b))
 
 
 ### Bug Fixes

package/README.md

@@ -45,7 +45,7 @@ As shown in the diagram, DocSmith integrates seamlessly with other [AIGNE](https
 
 - **AIGNE Hub Integration**: Use [AIGNE Hub](https://www.aigne.io/en/hub) without API keys, switch between Google Gemini, OpenAI GPT, Claude, and more
 - **Multiple LLM Support**: Bring your own API keys for OpenAI, Anthropic, Google, and other providers
-- **Discuss Kit Publishing**: Deploy to [docsmith.aigne.io](https://docsmith.aigne.io/app/) or your own [Discuss Kit](https://www.web3kit.rocks/discuss-kit) instance
+- **One-Click Publishing**: Make your docs live and generate shareable links for your team - publish to [docsmith.aigne.io](https://docsmith.aigne.io/app/) or your own [Discuss Kit](https://www.web3kit.rocks/discuss-kit) instance
 
 ### 🔄 Smart Updates
 

package/agents/clear/choose-contents.mjs

@@ -5,8 +5,8 @@ const TARGET_METADATA = {
     agent: "clearGeneratedDocs",
   },
   documentStructure: {
-    label: "document structure",
-    description: "Delete the document structure and all generated documents.",
+    label: "documentation structure",
+    description: "Delete the documentation structure and all generated documents.",
     agent: "clearDocumentStructure",
   },
   documentConfig: {

package/agents/clear/clear-document-structure.mjs

@@ -20,8 +20,8 @@ export default async function clearDocumentStructure(input = {}, _options = {})
 
     const structureDisplayPath = toDisplayPath(structurePlanPath);
     const structureMessage = structureExists
-      ? `Cleared document structure plan (${structureDisplayPath})`
-      : `Document structure plan already empty (${structureDisplayPath})`;
+      ? `Cleared documentation structure (${structureDisplayPath})`
+      : `Documentation structure already empty (${structureDisplayPath})`;
 
     results.push({
       type: "structure",
@@ -33,7 +33,7 @@ export default async function clearDocumentStructure(input = {}, _options = {})
     results.push({
       type: "structure",
       error: true,
-      message: `Failed to clear document structure plan: ${error.message}`,
+      message: `Failed to clear documentation structure: ${error.message}`,
     });
   }
 
@@ -69,11 +69,11 @@ export default async function clearDocumentStructure(input = {}, _options = {})
 
   let header;
   if (errorItems > 0) {
-    header = "Document structure cleanup finished with some issues.";
+    header = "Documentation Structure cleanup finished with some issues.";
   } else if (clearedItems > 0) {
-    header = "Document structure cleared successfully!";
+    header = "Documentation Structure cleared successfully!";
   } else {
-    header = "Document structure already empty.";
+    header = "Documentation Structure already empty.";
   }
 
   const detailLines = results.map((item) => `- ${item.message}`).join("\n");
@@ -101,6 +101,6 @@ clearDocumentStructure.input_schema = {
   },
 };
 
-clearDocumentStructure.taskTitle = "Clear document structure and all generated documents";
+clearDocumentStructure.taskTitle = "Clear documentation structure and all generated documents";
 clearDocumentStructure.description =
-  "Clear the document structure plan (structure-plan.json) and optionally the documents directory";
+  "Clear the documentation structure (structure-plan.json) and optionally the documents directory";

package/agents/clear/index.yaml

@@ -2,7 +2,7 @@ type: team
 name: clear
 alias:
   - clear
-description: Clear various types of data including document structure, generated documents, configuration, and authorization tokens
+description: Clear various types of data including documentation structure, generated documents, configuration, and authorization tokens
 skills:
   - url: ../init/index.mjs
     default_input:

package/agents/evaluate/document-structure.yaml

@@ -11,7 +11,7 @@ input_schema:
   properties:
     documentStructureYaml:
       type: string
-      description: Document structure planning
+      description: Documentation structure data
     purposes:
       type: string
       description: User-selected document goals

package/agents/generate/check-d2-diagram-valid.mjs

@@ -0,0 +1,26 @@
+import { checkContent } from "../../utils/d2-utils.mjs";
+
+export default async function checkD2DiagramIsValid({ d2DiagramSourceCode }) {
+  try {
+    await checkContent({ content: d2DiagramSourceCode });
+    return {
+      isValid: true,
+    };
+  } catch (err) {
+    return {
+      isValid: false,
+      error: err.message,
+    };
+  }
+}
+
+checkD2DiagramIsValid.input_schema = {
+  type: "object",
+  properties: {
+    d2DiagramSourceCode: {
+      type: "string",
+      description: "Source code of d2 diagram",
+    },
+  },
+  required: ["d2DiagramSourceCode"],
+};

package/agents/generate/check-document-structure.yaml

@@ -1,5 +1,5 @@
 name: checkDocumentStructure
-description: Check the Document Structure to ensure it meets expectations, especially in scenarios with previous generation results and user feedback.
+description: Check the Documentation Structure to ensure it meets expectations, especially in scenarios with previous generation results and user feedback.
 instructions:
   url: ../../prompts/structure/check-document-structure.md
 input_schema:
@@ -7,10 +7,10 @@ input_schema:
   properties:
     documentStructure:
       $ref: ../schema/document-structure.yaml
-      description: Newly generated document structure.
+      description: Newly generated documentation structure.
     originalDocumentStructure:
       $ref: ../schema/document-structure.yaml
-      description: Previous generation's document structure for comparison. If it doesn't exist, the check passes by default.
+      description: Previous generation's documentation structure for comparison. If it doesn't exist, the check passes by default.
     feedback:
       type: string
       description: User feedback provided for the previous generation's results.

package/agents/generate/check-need-generate-structure.mjs

@@ -18,10 +18,10 @@ export default async function checkNeedGenerateStructure(
   if (!originalDocumentStructure) {
     const choice = await options.prompts.select({
       message:
-        "Your project configuration is complete. Would you like to generate the document structure now?",
+        "Your project configuration is complete. Would you like to generate the documentation structure now?",
       choices: [
         {
-          name: "Generate now - Start generating the document structure",
+          name: "Generate now - Start generating the documentation structure",
           value: "generate",
         },
         {
@@ -49,7 +49,7 @@ export default async function checkNeedGenerateStructure(
     }
   }
 
-  // Check if we need to regenerate document structure
+  // Check if we need to regenerate documentation structure
   let shouldRegenerate = false;
   let finalFeedback = feedback;
 
@@ -82,7 +82,7 @@ export default async function checkNeedGenerateStructure(
       finalFeedback = `
       ${finalFeedback || ""}
 
-      Update document structure based on the latest DataSources:
+      Update documentation structure based on the latest DataSources:
         1. For new content, add new sections as needed or supplement existing section displays
         2. Be cautious when deleting sections, unless all associated sourceIds have been removed
         3. Do not modify the path of existing sections
@@ -97,11 +97,11 @@ export default async function checkNeedGenerateStructure(
     finalFeedback = `
     ${finalFeedback || ""}
 
-    User requested forced regeneration of document structure. Please regenerate based on the latest Data Sources and user requirements, **allowing any modifications**.
+    User requested forced regeneration of documentation structure. Please regenerate based on the latest Data Sources and user requirements, **allowing any modifications**.
     `;
   }
 
-  // If no regeneration needed, return original document structure
+  // If no regeneration needed, return original documentation structure
   if (originalDocumentStructure && !finalFeedback && !shouldRegenerate) {
     return {
       documentStructure: originalDocumentStructure,
@@ -110,7 +110,7 @@ export default async function checkNeedGenerateStructure(
 
   const planningAgent = options.context.agents["refineDocumentStructure"];
 
-  // Get user preferences for document structure and global scope
+  // Get user preferences for documentation structure and global scope
   const structureRules = getActiveRulesForScope("structure", []);
   const globalRules = getActiveRulesForScope("global", []);
 
@@ -185,4 +185,4 @@ export default async function checkNeedGenerateStructure(
   };
 }
 
-checkNeedGenerateStructure.taskTitle = "Check if document structure needs generate or update";
+checkNeedGenerateStructure.taskTitle = "Check if documentation structure needs generate or update";

package/agents/generate/document-structure-tools/add-document.mjs

@@ -41,7 +41,7 @@ export default async function addDocument(input) {
     sourceIds: [...sourceIds], // Create a copy of the array
   };
 
-  // Add the new document to the document structure
+  // Add the document to the structure
   const updatedStructure = [...documentStructure, newDocument];
 
   return {
@@ -50,7 +50,7 @@ export default async function addDocument(input) {
   };
 }
 
-addDocument.taskTitle = "Add new document";
-addDocument.description = "Add a new document to the document structure";
+addDocument.taskTitle = "Add document";
+addDocument.description = "Add a document to the documentation structure";
 addDocument.inputSchema = getAddDocumentInputJsonSchema();
 addDocument.outputSchema = getAddDocumentOutputJsonSchema();

package/agents/generate/document-structure-tools/delete-document.mjs

@@ -34,7 +34,7 @@ export default async function deleteDocument(input) {
     return { documentStructure };
   }
 
-  // Remove the document from the document structure
+  // Remove the document from the structure
   const updatedStructure = documentStructure.filter((_, index) => index !== documentIndex);
 
   return {
@@ -44,6 +44,6 @@ export default async function deleteDocument(input) {
 }
 
 deleteDocument.taskTitle = "Delete document";
-deleteDocument.description = "Delete a document from the document structure";
+deleteDocument.description = "Remove a document from the documentation structure";
 deleteDocument.inputSchema = getDeleteDocumentInputJsonSchema();
 deleteDocument.outputSchema = getDeleteDocumentOutputJsonSchema();

package/agents/generate/document-structure-tools/move-document.mjs

@@ -65,7 +65,7 @@ export default async function moveDocument(input) {
     parentId: newParentId || null,
   };
 
-  // Update the document structure
+  // Update the document's position in the structure
   const updatedStructure = [...documentStructure];
   updatedStructure[documentIndex] = updatedDocument;
 
@@ -77,6 +77,7 @@ export default async function moveDocument(input) {
 }
 
 moveDocument.taskTitle = "Move document";
-moveDocument.description = "Move a document to a different parent in the document structure";
+moveDocument.description =
+  "Relocate a document to a different parent in the documentation structure";
 moveDocument.inputSchema = getMoveDocumentInputJsonSchema();
 moveDocument.outputSchema = getMoveDocumentOutputJsonSchema();

package/agents/generate/document-structure-tools/update-document.mjs

@@ -33,7 +33,7 @@ export default async function updateDocument(input) {
     ...(sourceIds !== undefined && { sourceIds: [...sourceIds] }), // Create a copy of the array
   };
 
-  // Update the document structure
+  // Update the document in the structure
   const updatedStructure = [...documentStructure];
   updatedStructure[documentIndex] = updatedDocument;
 
@@ -45,6 +45,6 @@ export default async function updateDocument(input) {
 }
 
 updateDocument.taskTitle = "Update document";
-updateDocument.description = "Update properties of an existing document in the document structure";
+updateDocument.description = "Modify properties of a document in the documentation structure";
 updateDocument.inputSchema = getUpdateDocumentInputJsonSchema();
 updateDocument.outputSchema = getUpdateDocumentOutputJsonSchema();

package/agents/generate/generate-d2-diagram.yaml

@@ -0,0 +1,23 @@
+name: drawD2Diagram
+description: Generate a D2 diagram from document content.
+instructions:
+  - role: system
+    url: ../../prompts/detail/d2-diagram/rules-system.md
+  - role: user
+    url: ../../prompts/detail/d2-diagram/rules-user.md
+input_schema:
+  type: object
+  properties:
+    documentContent:
+      type: string
+      description: Source code of current document (without the D2 diagram)
+  required:
+    - documentContent
+output_schema:
+  type: object
+  properties:
+    d2DiagramSourceCode:
+      type: string
+      description: Source code to draw D2 diagram
+  required:
+    - d2DiagramSourceCode

package/agents/generate/generate-structure.yaml

@@ -13,7 +13,7 @@ input_schema:
       description: Primary language for documentation (e.g., zh, en, ja)
     datasources:
       type: string
-      description: Project content and context to help generate document structure
+      description: Project content and context to help generate documentation structure
     targetAudience:
       type: string
       description: Target audience for the documentation

package/agents/generate/merge-d2-diagram.yaml

@@ -0,0 +1,39 @@
+name: mergeD2DiagramToDocument
+description: Merge D2 Diagram source code into document
+instructions: |
+  You are an AI assistant that helps to merge d2 diagram into document.
+
+  <datasources>
+  {{ content }}
+  </datasources>
+  <datasources>
+  {{ d2DiagramSourceCode }}
+  </datasources>
+
+  Given the source content of a document and the D2 diagram source code, your task is to:
+  - **Keep the original content as soon as possible.**
+  - D2 diagram source code should wrap by ```d2 and ``` in markdown format.
+  - Should find proper position to insert the D2 diagram in the document, usually after the first paragraph or after the section that describes the diagram.
+  - If there is no suitable position, append it to the end of the document.
+  - If there is no D2 diagram source code, return the original document content without any changes.
+input_schema:
+  type: object
+  properties:
+    content:
+      type: string
+      description: Source content of the document
+    d2DiagramSourceCode:
+      type: string
+      description: Source content of D2 Diagram
+  required:
+    - content
+    - d2DiagramSourceCode
+output_schema:
+  type: object
+  properties:
+    content:
+      type: string
+      description: Merged content of the document with D2 diagram
+  required:
+    - content
+

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

@@ -1,6 +1,6 @@
 type: ai
 name: updateDocumentStructure
-description: Update document structure based on user feedback and intentions using structure modification tools
+description: Update documentation structure based on user feedback and intentions using structure modification tools
 instructions:
   url: ../../prompts/structure/update-document-structure.md
 input_schema:
@@ -15,7 +15,7 @@ input_schema:
       description: User language, e.g. zh, en
     datasources:
       type: string
-      description: Context for document structure
+      description: Context for documentation structure
     glossary:
       type: string
       description: Glossary of terms
@@ -34,7 +34,7 @@ output_schema:
     documentStructure: ../schema/document-structure.yaml
     operationSummary:
       type: string
-      description: Summary of the operations performed on the document structure
+      description: Summary of the operations performed on the documentation structure
 skills:
   - ./document-structure-tools/add-document.mjs
   - ./document-structure-tools/delete-document.mjs

package/agents/generate/user-review-document-structure.mjs

@@ -48,13 +48,13 @@ function formatDocumentStructure(structure) {
 
 function printDocumentStructure(structure) {
   console.log(`\n  ${"-".repeat(50)}`);
-  console.log("  Current Document Structure");
+  console.log("  Current Documentation Structure");
   console.log(`  ${"-".repeat(50)}`);
 
   const { rootNodes, printNode } = formatDocumentStructure(structure);
 
   if (rootNodes.length === 0) {
-    console.log("  No document structure found.");
+    console.log("  No documentation structure found.");
   } else {
     rootNodes.forEach((node) => {
       printNode(node);
@@ -64,19 +64,19 @@ function printDocumentStructure(structure) {
 }
 
 export default async function userReviewDocumentStructure({ documentStructure, ...rest }, options) {
-  // Check if document structure exists
+  // Check if documentation structure exists
   if (!documentStructure || !Array.isArray(documentStructure) || documentStructure.length === 0) {
-    console.log("No document structure was generated to review.");
+    console.log("No documentation structure was generated to review.");
     return { documentStructure };
   }
 
-  // Print current document structure in a user-friendly format
+  // Print current documentation structure in a user-friendly format
   printDocumentStructure(documentStructure);
 
-  // Ask user if they want to review the document structure
+  // Ask user if they want to review the documentation structure
   const needReview = await options.prompts.select({
     message:
-      "Would you like to optimize the document structure?\n  You can edit titles, reorganize sections.",
+      "Would you like to optimize the documentation structure?\n  You can edit titles, reorganize sections.",
     choices: [
       {
         name: "Looks good - proceed with current structure",
@@ -117,7 +117,7 @@ export default async function userReviewDocumentStructure({ documentStructure, .
     const refineAgent = options.context.agents["updateDocumentStructure"];
     if (!refineAgent) {
       console.log(
-        "Unable to process your feedback - the document structure update feature is unavailable.",
+        "Unable to process your feedback - the documentation structure update feature is unavailable.",
       );
       console.log("Please try again later or contact support if this continues.");
       break;
@@ -157,7 +157,7 @@ export default async function userReviewDocumentStructure({ documentStructure, .
         }
       }
 
-      // Print current document structure in a user-friendly format
+      // Print current documentation structure in a user-friendly format
       printDocumentStructure(currentStructure);
     } catch (error) {
       console.error("Error processing your feedback:");
@@ -172,4 +172,4 @@ export default async function userReviewDocumentStructure({ documentStructure, .
   return { documentStructure: currentStructure };
 }
 
-userReviewDocumentStructure.taskTitle = "User review and modify document structure";
+userReviewDocumentStructure.taskTitle = "User review and modify documentation structure";

package/agents/init/index.mjs

@@ -76,7 +76,7 @@ export default async function init(
 
   // 1. Primary purpose - what's the main outcome you want readers to achieve?
   const purposeChoices = await options.prompts.checkbox({
-    message: "📝 [1/8]: What should your documentation help readers achieve?",
+    message: "📝 [1/9]: What should your documentation help readers achieve?",
     choices: Object.entries(DOCUMENT_STYLES)
       .filter(([key]) => key !== "custom") // Remove custom option for multiselect
       .map(([key, style]) => ({
@@ -124,7 +124,7 @@ export default async function init(
 
   // 2. Target audience - who will be reading this most often?
   const audienceChoices = await options.prompts.checkbox({
-    message: "👥 [2/8]: Who will be reading your documentation?",
+    message: "👥 [2/9]: Who will be reading your documentation?",
     choices: Object.entries(TARGET_AUDIENCES)
       .filter(([key]) => key !== "custom") // Remove custom option for multiselect
       .map(([key, audience]) => ({
@@ -143,7 +143,15 @@ export default async function init(
   // Save target audience choices as keys
   input.targetAudienceTypes = audienceChoices;
 
-  // 3. Reader knowledge level - what do readers typically know when they arrive?
+  // 3. Custom rules - any specific requirements for the documentation?
+  const rulesInput = await options.prompts.input({
+    message:
+      "📋 [3/9]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)",
+    default: "",
+  });
+  input.rules = rulesInput.trim();
+
+  // 4. Reader knowledge level - what do readers typically know when they arrive?
   // Determine default based on selected purposes using mapping
   const mappedPurpose = prioritizedPurposes.find(
     (purpose) => PURPOSE_TO_KNOWLEDGE_MAPPING[purpose],
@@ -158,7 +166,7 @@ export default async function init(
   );
 
   const knowledgeChoice = await options.prompts.select({
-    message: "🧠 [3/8]: How much do readers already know about your project?",
+    message: "🧠 [4/9]: How much do readers already know about your project?",
     choices: Object.entries(filteredKnowledgeOptions).map(([key, level]) => ({
       name: `${level.name}`,
       description: level.description,
@@ -203,7 +211,7 @@ export default async function init(
   );
 
   const depthChoice = await options.prompts.select({
-    message: "📊 [4/8]: How detailed should your documentation be?",
+    message: "📊 [5/9]: How detailed should your documentation be?",
     choices: Object.entries(filteredDepthOptions).map(([key, depth]) => ({
       name: `${depth.name}`,
       description: depth.description,
@@ -221,7 +229,7 @@ export default async function init(
 
   // Let user select primary language from supported list
   const primaryLanguageChoice = await options.prompts.select({
-    message: "🌐 [5/8]: What's your main documentation language?",
+    message: "🌐 [6/9]: What's your main documentation language?",
     choices: SUPPORTED_LANGUAGES.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -238,7 +246,7 @@ export default async function init(
   );
 
   const translateLanguageChoices = await options.prompts.checkbox({
-    message: "🔄 [6/8]: Which languages should we translate to?",
+    message: "🔄 [7/9]: Which languages should we translate to?",
     choices: availableTranslationLanguages.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -249,13 +257,13 @@ export default async function init(
 
   // 7. Documentation directory
   const docsDirInput = await options.prompts.input({
-    message: `📁 [7/8]: Where should we save your documentation?`,
+    message: `📁 [8/9]: Where should we save your documentation?`,
     default: `${outputPath}/docs`,
   });
   input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
 
   // 8. Content sources
-  console.log("\n🔍 [8/8]: Content Sources");
+  console.log("\n🔍 [9/9]: Content Sources");
   console.log(
     "What folders/files should we analyze for documentation? (e.g., ./src, ./docs, ./README.md)",
   );
@@ -400,7 +408,7 @@ export function generateYAML(input) {
     documentationDepth: input.documentationDepth || "",
 
     // Custom rules and target audience (empty for user to fill)
-    rules: "",
+    rules: input.rules || "",
     targetAudience: "",
 
     // Language settings