solo-doc 0.2.4 → 0.2.6

package/README.md

@@ -109,13 +109,15 @@ solo-doc vs \
   "https://docs.alauda.io/container_platform/4.2/developer/building_application/index.html"
 
 # 临时覆盖使用的模型
-solo-doc vs <url1> <url2> --model gpt-4
+solo-doc vs <url1> <url2>
 ```
 
 此命令将按顺序执行：
 1. **自动爬取**: 分别爬取两个 URL 并保存为 Markdown 文件（如果已存在则跳过）。
 2. **提取目录**: 提取两个文档的目录树结构。
 3. **AI 分析**: 调用配置的 AI 模型，根据 `solo-doc-prompt.md` 定义的提示词进行两步分析：
+   > **提示**: `solo-doc` 会优先使用当前执行目录下的 `solo-doc-prompt.md` 文件。你可以复制默认模板到当前目录进行自定义修改。若当前目录不存在该文件，则使用内置默认模板。
+
    - 生成 `vs-result.md`: 详细的内容与结构差异分析。
    - 生成 `vs-tree.md`: 包含差异标注的合并目录树。
 
@@ -123,7 +125,6 @@ solo-doc vs <url1> <url2> --model gpt-4
 
 | 选项 | 描述 | 默认值 |
 |--------|-------------|---------|
-| `--model <name>` | 临时覆盖配置文件中的模型名称。 | Config中的 `MODEL_NAME` |
 | `-f, --force` | 强制重新爬取文档，即使文件已存在。 | false |
 
 ## ✅ 环境要求

package/dist/bin/solo-doc.js

@@ -43,10 +43,9 @@ program
     .description('Compare two documentation sites using AI (Beta)')
     .argument('<baseline>', 'Baseline documentation URL')
     .argument('<target>', 'Target documentation URL')
-    .option('--model <model>', 'AI Model name (overrides .solodocrc.yml)')
     .action(async (baseline, target, options) => {
     try {
-        console.log(chalk_1.default.yellow('⚠️  [Beta Feature] This feature requires AI configuration in .solodocrc.yml or --model argument'));
+        console.log(chalk_1.default.yellow('⚠️  [Beta Feature] This feature requires AI configuration in .solodocrc.yml'));
         await VSCommand_1.VSCommand.run(baseline, target, options);
     }
     catch (error) {

package/dist/src/commands/VSCommand.js

@@ -43,17 +43,23 @@ class VSCommand {
             promptContent = fs_1.default.readFileSync(promptPath, 'utf-8');
         }
         else {
-            // Try to look in package root (assuming we might be running from bin)
-            // or just fail gracefully
-            const altPath = path_1.default.resolve(__dirname, '../../solo-doc-prompt.md');
-            if (fs_1.default.existsSync(altPath)) {
-                promptContent = fs_1.default.readFileSync(altPath, 'utf-8');
+            // Fallback 1: Try finding in package root (Development mode: src/commands/ -> ../../)
+            const devPath = path_1.default.resolve(__dirname, '../../solo-doc-prompt.md');
+            // Fallback 2: Try finding in package root (Production mode: dist/src/commands/ -> ../../../)
+            const prodPath = path_1.default.resolve(__dirname, '../../../solo-doc-prompt.md');
+            if (fs_1.default.existsSync(devPath)) {
+                console.log(chalk_1.default.gray(`[VS Mode] Using prompt from project root (dev): ${devPath}`));
+                promptContent = fs_1.default.readFileSync(devPath, 'utf-8');
+            }
+            else if (fs_1.default.existsSync(prodPath)) {
+                console.log(chalk_1.default.gray(`[VS Mode] Using prompt from project root (prod): ${prodPath}`));
+                promptContent = fs_1.default.readFileSync(prodPath, 'utf-8');
             }
             else {
                 console.warn(chalk_1.default.yellow('[VS Mode] Warning: solo-doc-prompt.md not found. Using default internal prompts.'));
                 // Define fallback prompts here if needed, or throw
                 // For now, let's throw to ensure user provides the file as requested
-                throw new Error('Could not find solo-doc-prompt.md in current directory.');
+                throw new Error('Could not find solo-doc-prompt.md in current directory or project root.');
             }
         }
         const prompts = VSCommand.parsePrompts(promptContent);

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "solo-doc",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "main": "dist/bin/solo-doc.js",
   "bin": {
     "solo-doc": "dist/bin/solo-doc.js"
   },
   "files": [
     "dist/**/*",
-    "README.md"
+    "README.md",
+    "solo-doc-prompt.md"
   ],
   "scripts": {
     "clean": "rm -rf dist",

package/solo-doc-prompt.md

@@ -0,0 +1,33 @@
+# 第一步：独立对比两个文档
+**目的**：生成详细对比，按维度分类；强调补充建议。
+**Prompt模板**：
+```
+基于以下OpenShift文档（基准）的目录树：[看附件ocp的文档目录树]，和Alauda文档的目录树：[看附件alauda的文档目录树]。
+
+以OpenShift为基准，对比Alauda，按以下维度详细总结对比，分别按照以下几个维护使用表格展示对比差异，包括具体差异如功能点、示例、CLI命令：
+
+1. OpenShift有，但是Alauda没有的章节/功能（列出缺失点，并建议如何补充Alauda以对标，如添加类似章节、功能实现）。
+2. OpenShift没有，但是Alauda有的章节/功能（分析独有价值，并建议OpenShift是否借鉴）。
+3. 两者都有的章节，差异在哪？谁写的更好（比较全面性、深度、实用性、示例数量；建议Alauda如何改进以对标OpenShift，如增加CLI示例、故障诊断）。
+
+总结用中文描述，保持章节标题英文。提供证据，补充对应文档中的链接，如具体子章节差异。
+```
+
+# 第二步 整合对比到OpenShift的文档树
+**目的**：嵌入详细对比到树中，确保链接完整。
+**Prompt模板**：
+```
+基于OpenShift文档的目录树，和上面的详细对比总结。
+将对比结果整合到OpenShift的Markdown树中：在每个章节或子章节（不超过3 级）后先补充上[相关链接]：
+- **Comparison with Alauda**: [详细对比描述，用中文，200-300字，内容包括差异、谁更好、Alauda补充建议]。
+  - **Alauda Link**: [相关链接或No relevant links，确保无空白]。
+
+最终输出使用1-3级Markdown标题整理（## Chapter X, ### Subchapter 等）。确保所有概要和对比用中文（专业术语、标题、链接保持英文）。
+```
+
+# 第三步 检查补全
+**目的**：整体检查，确保无漏/简陋
+**Prompt模板**：
+```
+对照附件 ocp 的文档树，有章节缺失，检查一下并补全
+```