@aigne/doc-smith 0.9.0-beta → 0.9.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.0-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.0-beta...v0.9.0-beta.1) (2025-11-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* remove terminal-link ([#289](https://github.com/AIGNE-io/aigne-doc-smith/issues/289)) ([eaaad2f](https://github.com/AIGNE-io/aigne-doc-smith/commit/eaaad2f1713f32ea8e72929aaa9c06949dbd00ca))
|
|
9
|
+
|
|
3
10
|
## [0.9.0-beta](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.16-beta.1...v0.9.0-beta) (2025-11-11)
|
|
4
11
|
|
|
5
12
|
|
|
@@ -83,11 +83,14 @@ export default async function clearGeneratedDocs(input = {}, options = {}) {
|
|
|
83
83
|
for (const file of filesToDelete) {
|
|
84
84
|
try {
|
|
85
85
|
const filePath = join(generatedDocsPath, file);
|
|
86
|
-
await rm(filePath
|
|
86
|
+
await rm(filePath);
|
|
87
87
|
deletedFiles.push(file);
|
|
88
88
|
} catch (error) {
|
|
89
|
-
|
|
90
|
-
|
|
89
|
+
// ignore if file not found
|
|
90
|
+
if (!["ENOENT"].includes(error.code)) {
|
|
91
|
+
hasError = true;
|
|
92
|
+
failedFiles.push({ file, error: error.message });
|
|
93
|
+
}
|
|
91
94
|
}
|
|
92
95
|
}
|
|
93
96
|
|
package/agents/init/index.mjs
CHANGED
|
@@ -278,7 +278,7 @@ async function _init(
|
|
|
278
278
|
input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
|
|
279
279
|
|
|
280
280
|
// 8. Content sources
|
|
281
|
-
console.log("
|
|
281
|
+
console.log("🔍 [8/9]: Data Sources");
|
|
282
282
|
console.log("Please specify the data source we should analyze to generate your documentation.");
|
|
283
283
|
console.log(
|
|
284
284
|
` 1. Use paths like ${chalk.green("./src")}, ${chalk.green("./README.md")} or ${chalk.green("!./src/private")}.`,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aigne/doc-smith",
|
|
3
|
-
"version": "0.9.0-beta",
|
|
3
|
+
"version": "0.9.0-beta.1",
|
|
4
4
|
"description": "AI-driven documentation generation tool built on the AIGNE Framework",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -53,7 +53,6 @@
|
|
|
53
53
|
"remark-gfm": "^4.0.1",
|
|
54
54
|
"remark-lint": "^10.0.1",
|
|
55
55
|
"remark-parse": "^11.0.0",
|
|
56
|
-
"terminal-link": "^5.0.0",
|
|
57
56
|
"typescript": "^5.9.3",
|
|
58
57
|
"ufo": "^1.6.1",
|
|
59
58
|
"unified": "^11.0.5",
|
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
|
|
8
8
|
** Output content in {{ locale }} language. **
|
|
9
9
|
|
|
10
|
-
|
|
11
10
|
</user_rules>
|
|
12
11
|
|
|
13
12
|
{% set operation_type = "generating" %}
|
|
@@ -37,12 +36,6 @@
|
|
|
37
36
|
|
|
38
37
|
{% include "./detail-example.md" %}
|
|
39
38
|
|
|
40
|
-
{% if content %}
|
|
41
|
-
<previous_generation_content>
|
|
42
|
-
{{content}}
|
|
43
|
-
</previous_generation_content>
|
|
44
|
-
{% endif %}
|
|
45
|
-
|
|
46
39
|
{% if detailFeedback %}
|
|
47
40
|
<content_review_feedback>
|
|
48
41
|
{{ detailFeedback }}
|
|
@@ -56,6 +49,28 @@ User feedback on previous generation:
|
|
|
56
49
|
</feedback>
|
|
57
50
|
{% endif %}
|
|
58
51
|
|
|
52
|
+
{% if content %}
|
|
53
|
+
|
|
54
|
+
<previous_generation_content>
|
|
55
|
+
{{content}}
|
|
56
|
+
</previous_generation_content>
|
|
57
|
+
|
|
58
|
+
<instructions>
|
|
59
|
+
Analyze the previous document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
|
|
60
|
+
</instructions>
|
|
61
|
+
|
|
62
|
+
{% elseif originalContent %}
|
|
63
|
+
|
|
64
|
+
<previous_generation_content>
|
|
65
|
+
{{originalContent}}
|
|
66
|
+
</previous_generation_content>
|
|
67
|
+
|
|
68
|
+
<instructions>
|
|
69
|
+
Analyze the previous document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
|
|
70
|
+
</instructions>
|
|
71
|
+
|
|
72
|
+
{% else %}
|
|
73
|
+
|
|
59
74
|
<instructions>
|
|
60
75
|
Generate detailed and well-structured document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), `<detail_data_source>`, `<document_structure>` (overall structural planning), and other relevant information.
|
|
61
76
|
|
|
@@ -65,3 +80,6 @@ Generate detailed and well-structured document for the current {{nodeName}} base
|
|
|
65
80
|
3. Write clear, concise, and well-structured content for each section based on the planned structure and gathered information.
|
|
66
81
|
</steps>
|
|
67
82
|
</instructions>
|
|
83
|
+
|
|
84
|
+
{% endif %}
|
|
85
|
+
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { existsSync } from "node:fs";
|
|
2
2
|
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
|
3
|
-
import { dirname, join
|
|
4
|
-
import { fileURLToPath
|
|
5
|
-
import terminalLink from "terminal-link";
|
|
3
|
+
import { dirname, join } from "node:path";
|
|
4
|
+
import { fileURLToPath } from "node:url";
|
|
6
5
|
|
|
7
6
|
import { toRelativePath } from "../utils.mjs";
|
|
8
7
|
|
|
@@ -117,8 +116,6 @@ export async function copyHtmlReportTemplate(targetDir, data) {
|
|
|
117
116
|
* @returns {string} Success message with links
|
|
118
117
|
*/
|
|
119
118
|
export function generateReportSuccessMessage(jsonReportPath, htmlReportPath) {
|
|
120
|
-
const openHtmlPath = resolve(htmlReportPath);
|
|
121
|
-
const openUrl = pathToFileURL(openHtmlPath);
|
|
122
119
|
return `# ✅ Documentation Evaluation Report Generated Successfully!
|
|
123
120
|
|
|
124
121
|
Generated evaluation report and saved to:
|
|
@@ -129,7 +126,7 @@ Generated evaluation report and saved to:
|
|
|
129
126
|
|
|
130
127
|
Open in your browser to view detailed analysis:
|
|
131
128
|
|
|
132
|
-
|
|
129
|
+
\`Run in terminal: open ${htmlReportPath}\`
|
|
133
130
|
|
|
134
131
|
`;
|
|
135
132
|
}
|