@aigne/doc-smith 0.8.12-beta.7 → 0.8.12-beta.8

package/utils/constants/index.mjs

@@ -548,110 +548,3 @@ export const DOC_SMITH_DIR = ".aigne/doc-smith";
 export const TMP_DIR = ".tmp";
 export const TMP_DOCS_DIR = "docs";
 export const TMP_ASSETS_DIR = "assets";
-
-// Default evaluation scoring weights
-export const DEFAULT_EVALUATION_WEIGHTS = {
-  evaluationConfig: {
-    accuracy: {
-      weight: 0.35,
-      description: "Technical correctness of the documentation.",
-      subDimensions: {
-        signatureConsistency: {
-          weight: 0.5,
-          description:
-            "Function signatures match the source code (e.g., OpenAPI spec, TypeScript types).",
-        },
-        linkValidity: {
-          weight: 0.25,
-          description: "No broken internal links or invalid cross-references.",
-        },
-        codeExampleIntegrity: {
-          weight: 0.25,
-          description:
-            "All code blocks are syntactically valid and labeled with the correct language.",
-        },
-      },
-    },
-    coverage: {
-      weight: 0.35,
-      description: "Completeness of documentation for all public components.",
-      subDimensions: {
-        apiCoverage: {
-          weight: 0.4,
-          description: "Percentage of exported functions/classes documented.",
-        },
-        paramReturnCoverage: {
-          weight: 0.3,
-          description: "Percentage of function parameters and return values described.",
-        },
-        changeTracking: {
-          weight: 0.3,
-          description:
-            "All new or modified code since the last commit is reflected in the documentation.",
-        },
-      },
-    },
-    readability: {
-      weight: 0.15,
-      description: "Ease of understanding for human readers.",
-      subDimensions: {
-        clarityScore: {
-          weight: 0.28,
-          description:
-            "Overall clarity including reading coherence, logical flow and translation quality.",
-        },
-        consistency: {
-          weight: 0.12,
-          description: "Terminology, style and formatting are unified and professional.",
-        },
-        contentQuality: {
-          weight: 0.24,
-          description:
-            "Accurate and complete content that adds value with sufficient detail and examples.",
-        },
-        purposeAlignment: {
-          weight: 0.14,
-          description:
-            "Content matches the intended purpose such as quick start, API reference or troubleshooting.",
-        },
-        audienceAlignment: {
-          weight: 0.12,
-          description:
-            "Language and examples match the target audience (e.g., developers, non-technical users).",
-        },
-        knowledgeLevelAlignment: {
-          weight: 0.1,
-          description: "Depth and difficulty fit the readers' knowledge level.",
-        },
-      },
-    },
-    structure: {
-      weight: 0.15,
-      description: "Organization and navigability of the documentation.",
-      subDimensions: {
-        navigability: {
-          weight: 0.2,
-          description: "Table of contents entries correctly link to headings.",
-        },
-        informationScent: {
-          weight: 0.2,
-          description:
-            "Key pages such as Quick Start can be reached within three clicks from the homepage.",
-        },
-        purposeCoverage: {
-          weight: 0.25,
-          description:
-            "Structure covers all selected documentation goals without forcing them into a single page.",
-        },
-        audienceCoverage: {
-          weight: 0.2,
-          description: "Structure covers the main intended audience groups.",
-        },
-        coverageDepthAlignment: {
-          weight: 0.15,
-          description: "Overall balance of conciseness, depth and breadth meets user expectations.",
-        },
-      },
-    },
-  },
-};

package/utils/file-utils.mjs

@@ -558,3 +558,44 @@ export function getStructurePlanPath(workDir) {
   const cwd = workDir || process.cwd();
   return path.join(cwd, ".aigne", "doc-smith", "output", "structure-plan.json");
 }
+
+/**
+ * Get MIME type from file path based on extension
+ * @param {string} filePath - File path
+ * @returns {string} MIME type
+ */
+export function getMimeType(filePath) {
+  const ext = path.extname(filePath).toLowerCase();
+  const mimeTypes = {
+    ".jpg": "image/jpeg",
+    ".jpeg": "image/jpeg",
+    ".png": "image/png",
+    ".gif": "image/gif",
+    ".bmp": "image/bmp",
+    ".webp": "image/webp",
+    ".svg": "image/svg+xml",
+    ".heic": "image/heic",
+    ".heif": "image/heif",
+    ".mp4": "video/mp4",
+    ".mpeg": "video/mpeg",
+    ".mpg": "video/mpg",
+    ".mov": "video/mov",
+    ".avi": "video/avi",
+    ".flv": "video/x-flv",
+    ".mkv": "video/x-matroska",
+    ".webm": "video/webm",
+    ".wmv": "video/wmv",
+    ".m4v": "video/x-m4v",
+    ".3gpp": "video/3gpp",
+  };
+  return mimeTypes[ext] || "application/octet-stream";
+}
+
+/**
+ * Get media description cache file path
+ * @returns {string} Absolute path to media-description.yaml
+ */
+export function getMediaDescriptionCachePath() {
+  const cwd = process.cwd();
+  return path.join(cwd, ".aigne", "doc-smith", "media-description.yaml");
+}

package/media.md

@@ -1,19 +0,0 @@
-# 提供在文档中可使用的媒体素材
-
-![运行 generate 命令，智能执行初始化](./assets/screenshots/doc-generate.png)
-
-![回答问题完成项目设置](./assets/screenshots/doc-complete-setup.png)
-
-![执行结构规划和生成文档](./assets/screenshots/doc-generate-docs.png)
-
-![文档生成成功](./assets/screenshots/doc-generated-successfully.png)
-
-![智能检测，只重新生成需要的文档](./assets/screenshots/doc-regenerate.png)
-
-![交互式选择需要更新文档](./assets/screenshots/doc-update.png)
-
-![发布文档到官方平台或自部署平台](./assets/screenshots/doc-publish.png)
-
-![选择需要翻译的文档](./assets/screenshots/doc-translate.png)
-
-![选择需要翻译的语言](./assets/screenshots/doc-translate-langs.png)