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

package/utils/constants/index.mjs

@@ -350,7 +350,7 @@ export const SUPPORTED_FILE_EXTENSIONS = [".txt", ".md", ".json", ".yaml", ".yml
 export const CONFLICT_RULES = {
   // Internal conflicts within the same question (multi-select conflicts)
   internalConflicts: {
-    // Note: Most conflicts can be resolved through intelligent document structure
+    // Note: Most conflicts can be resolved through intelligent documentation structure
     // Only keeping conflicts that represent fundamental incompatibilities
   },
 
@@ -424,7 +424,7 @@ export const CONFLICT_RULES = {
 
 // Conflict resolution rules - defines how to handle conflicts when users select conflicting options
 export const CONFLICT_RESOLUTION_RULES = {
-  // Document purpose conflicts that can be resolved through document structure
+  // Document purpose conflicts that can be resolved through documentation structure
   documentPurpose: [
     {
       conflictItems: ["getStarted", "findAnswers"],
@@ -451,7 +451,7 @@ export const CONFLICT_RESOLUTION_RULES = {
     },
   ],
 
-  // Target audience conflicts that can be resolved through document structure
+  // Target audience conflicts that can be resolved through documentation structure
   targetAudienceTypes: [
     {
       conflictItems: ["endUsers", "developers"],
@@ -475,7 +475,7 @@ export const CONFLICT_RESOLUTION_RULES = {
 // Resolution strategy descriptions
 export const RESOLUTION_STRATEGIES = {
   layered_structure: (items) =>
-    `Detected "${items.join('" and "')}" purpose conflict. Resolution strategy: Create layered document structure
+    `Detected "${items.join('" and "')}" purpose conflict. Resolution strategy: Create layered documentation structure
 - Quick start section: Uses "get started" style - optimizes for speed, key steps, working examples, skips complex edge cases
 - API reference section: Uses "find answers" style - comprehensive coverage, searchability, rich examples, skips narrative flow
 - Ensure sections complement rather than conflict with each other`,

package/utils/docs-finder-utils.mjs

@@ -24,8 +24,8 @@ function generateFileName(flatName, locale) {
 }
 
 /**
- * Find a single item by path in document structure result and read its content
- * @param {Array} documentExecutionStructure - Array of document structure items
+ * Find a single item by path in documentation structure result and read its content
+ * @param {Array} documentExecutionStructure - Array of documentation structure items
  * @param {string} docPath - Document path to find (supports .md filenames)
  * @param {string} boardId - Board ID for fallback matching
  * @param {string} docsDir - Docs directory path for reading content
@@ -116,7 +116,7 @@ export async function readFileContent(docsDir, fileName) {
  * Get main language markdown files from docs directory
  * @param {string} docsDir - Docs directory path
  * @param {string} locale - Main language locale (e.g., 'en', 'zh', 'fr')
- * @param {Array} documentExecutionStructure - Array of document structure items to determine file order
+ * @param {Array} documentExecutionStructure - Array of documentation structure items to determine file order
  * @returns {Promise<string[]>} Array of main language .md files ordered by documentExecutionStructure
  */
 export async function getMainLanguageFiles(docsDir, locale, documentExecutionStructure = null) {
@@ -153,7 +153,7 @@ export async function getMainLanguageFiles(docsDir, locale, documentExecutionStr
 
   // If documentExecutionStructure is provided, sort files according to the order in documentExecutionStructure
   if (documentExecutionStructure && Array.isArray(documentExecutionStructure)) {
-    // Create a map from flat file name to document structure order
+    // Create a map from flat file name to documentation structure order
     const orderMap = new Map();
     documentExecutionStructure.forEach((item, index) => {
       const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
@@ -166,16 +166,16 @@ export async function getMainLanguageFiles(docsDir, locale, documentExecutionStr
       const orderA = orderMap.get(a);
       const orderB = orderMap.get(b);
 
-      // If both files are in the document structure, sort by order
+      // If both files are in the documentation structure, sort by order
       if (orderA !== undefined && orderB !== undefined) {
         return orderA - orderB;
       }
 
-      // If only one file is in the document structure, it comes first
+      // If only one file is in the documentation structure, it comes first
       if (orderA !== undefined) return -1;
       if (orderB !== undefined) return 1;
 
-      // If neither file is in the document structure, maintain alphabetical order
+      // If neither file is in the documentation structure, maintain alphabetical order
       return a.localeCompare(b);
     });
   }
@@ -200,8 +200,8 @@ export function fileNameToFlatPath(fileName) {
 }
 
 /**
- * Find document structure item by flattened file name
- * @param {Array} documentExecutionStructure - Array of document structure items
+ * Find documentation structure item by flattened file name
+ * @param {Array} documentExecutionStructure - Array of documentation structure items
  * @param {string} flatName - Flattened file name
  * @returns {Object|null} Found item or null
  */
@@ -215,7 +215,7 @@ export function findItemByFlatName(documentExecutionStructure, flatName) {
 /**
  * Process selected files and convert to found items with content
  * @param {string[]} selectedFiles - Array of selected file names
- * @param {Array} documentExecutionStructure - Array of document structure items
+ * @param {Array} documentExecutionStructure - Array of documentation structure items
  * @param {string} docsDir - Docs directory path
  * @returns {Promise<Object[]>} Array of found items with content
  */
@@ -244,7 +244,7 @@ export async function processSelectedFiles(selectedFiles, documentExecutionStruc
 
       foundItems.push(result);
     } else {
-      console.warn(`⚠️  No document structure item found for file: ${selectedFile}`);
+      console.warn(`⚠️  No documentation structure item found for file: ${selectedFile}`);
     }
   }
 

package/utils/markdown-checker.mjs

@@ -87,7 +87,7 @@ function checkDeadLinks(markdown, source, allowedLinks, errorMessages) {
     // Check if this link is in the allowed links set
     if (!allowedLinks.has(path)) {
       errorMessages.push(
-        `Found a dead link in ${source}: [${match[1]}](${trimLink}), ensure the link exists in the document structure path`,
+        `Found a dead link in ${source}: [${match[1]}](${trimLink}), ensure the link exists in the documentation structure path`,
       );
     }
   }