@aigne/doc-smith 0.8.11-beta.6 → 0.8.11-beta.7
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/.aigne/doc-smith/config.yaml +2 -0
- package/.aigne/doc-smith/output/structure-plan.json +2 -2
- package/.aigne/doc-smith/preferences.yml +28 -20
- package/.aigne/doc-smith/upload-cache.yaml +702 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +13 -0
- package/README.md +1 -1
- package/agents/generate/document-structure-tools/add-document.mjs +35 -10
- package/agents/generate/document-structure-tools/delete-document.mjs +35 -12
- package/agents/generate/document-structure-tools/move-document.mjs +43 -17
- package/agents/generate/document-structure-tools/update-document.mjs +37 -10
- package/agents/generate/update-document-structure.yaml +1 -7
- package/agents/generate/user-review-document-structure.mjs +5 -4
- package/agents/translate/translate-document.yaml +1 -9
- package/agents/update/check-update-is-single.mjs +2 -1
- package/agents/update/document-tools/update-document-content.mjs +24 -14
- package/agents/update/fs-tools/glob.mjs +184 -0
- package/agents/update/fs-tools/grep.mjs +317 -0
- package/agents/update/fs-tools/read-file.mjs +307 -0
- package/agents/update/generate-document.yaml +4 -7
- package/agents/update/update-document-detail.yaml +6 -10
- package/agents/update/user-review-document.mjs +13 -13
- package/assets/screenshots/doc-complete-setup.png +0 -0
- package/assets/screenshots/doc-generate-docs.png +0 -0
- package/assets/screenshots/doc-generate.png +0 -0
- package/assets/screenshots/doc-generated-successfully.png +0 -0
- package/assets/screenshots/doc-publish.png +0 -0
- package/assets/screenshots/doc-regenerate.png +0 -0
- package/assets/screenshots/doc-translate-langs.png +0 -0
- package/assets/screenshots/doc-translate.png +0 -0
- package/assets/screenshots/doc-update.png +0 -0
- package/docs/advanced-how-it-works.ja.md +31 -31
- package/docs/advanced-how-it-works.md +9 -9
- package/docs/advanced-how-it-works.zh-TW.md +24 -24
- package/docs/advanced-how-it-works.zh.md +20 -20
- package/docs/advanced-quality-assurance.ja.md +57 -61
- package/docs/advanced-quality-assurance.md +57 -61
- package/docs/advanced-quality-assurance.zh-TW.md +57 -61
- package/docs/advanced-quality-assurance.zh.md +57 -61
- package/docs/advanced.ja.md +8 -4
- package/docs/advanced.md +7 -3
- package/docs/advanced.zh-TW.md +9 -5
- package/docs/advanced.zh.md +9 -5
- package/docs/changelog.ja.md +206 -29
- package/docs/changelog.md +177 -0
- package/docs/changelog.zh-TW.md +229 -52
- package/docs/changelog.zh.md +204 -27
- package/docs/cli-reference.ja.md +82 -52
- package/docs/cli-reference.md +56 -26
- package/docs/cli-reference.zh-TW.md +82 -52
- package/docs/cli-reference.zh.md +70 -40
- package/docs/configuration-interactive-setup.ja.md +45 -42
- package/docs/configuration-interactive-setup.md +8 -5
- package/docs/configuration-interactive-setup.zh-TW.md +26 -23
- package/docs/configuration-interactive-setup.zh.md +25 -22
- package/docs/configuration-language-support.ja.md +33 -63
- package/docs/configuration-language-support.md +32 -62
- package/docs/configuration-language-support.zh-TW.md +35 -65
- package/docs/configuration-language-support.zh.md +32 -62
- package/docs/configuration-llm-setup.ja.md +25 -23
- package/docs/configuration-llm-setup.md +20 -18
- package/docs/configuration-llm-setup.zh-TW.md +21 -19
- package/docs/configuration-llm-setup.zh.md +20 -18
- package/docs/configuration-preferences.ja.md +67 -52
- package/docs/configuration-preferences.md +56 -41
- package/docs/configuration-preferences.zh-TW.md +69 -54
- package/docs/configuration-preferences.zh.md +68 -53
- package/docs/configuration.ja.md +65 -81
- package/docs/configuration.md +19 -35
- package/docs/configuration.zh-TW.md +62 -79
- package/docs/configuration.zh.md +50 -67
- package/docs/features-generate-documentation.ja.md +44 -69
- package/docs/features-generate-documentation.md +36 -61
- package/docs/features-generate-documentation.zh-TW.md +42 -67
- package/docs/features-generate-documentation.zh.md +41 -67
- package/docs/features-publish-your-docs.ja.md +36 -36
- package/docs/features-publish-your-docs.md +2 -2
- package/docs/features-publish-your-docs.zh-TW.md +21 -21
- package/docs/features-publish-your-docs.zh.md +23 -23
- package/docs/features-translate-documentation.ja.md +40 -31
- package/docs/features-translate-documentation.md +15 -6
- package/docs/features-translate-documentation.zh-TW.md +37 -28
- package/docs/features-translate-documentation.zh.md +23 -14
- package/docs/features-update-and-refine.ja.md +68 -118
- package/docs/features-update-and-refine.md +58 -108
- package/docs/features-update-and-refine.zh-TW.md +67 -116
- package/docs/features-update-and-refine.zh.md +64 -114
- package/docs/features.ja.md +29 -19
- package/docs/features.md +25 -15
- package/docs/features.zh-TW.md +28 -18
- package/docs/features.zh.md +31 -21
- package/docs/getting-started.ja.md +40 -43
- package/docs/getting-started.md +36 -39
- package/docs/getting-started.zh-TW.md +38 -41
- package/docs/getting-started.zh.md +45 -48
- package/docs/overview.ja.md +63 -11
- package/docs/overview.md +60 -8
- package/docs/overview.zh-TW.md +67 -15
- package/docs/overview.zh.md +62 -10
- package/media.md +9 -9
- package/package.json +1 -1
- package/prompts/detail/custom/custom-components.md +304 -188
- package/prompts/detail/document-rules.md +4 -4
- package/prompts/detail/generate-document.md +21 -8
- package/prompts/detail/update-document.md +8 -12
- package/prompts/structure/update-document-structure.md +12 -8
- package/prompts/utils/feedback-refiner.md +3 -3
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +9 -9
- package/tests/agents/generate/user-review-document-structure.test.mjs +29 -8
- package/tests/agents/update/document-tools/update-document-content.test.mjs +115 -112
- package/tests/agents/update/fs-tools/glob.test.mjs +438 -0
- package/tests/agents/update/fs-tools/grep.test.mjs +279 -0
- package/tests/agents/update/fs-tools/read-file.test.mjs +553 -0
- package/tests/agents/update/user-review-document.test.mjs +48 -27
- package/types/document-schema.mjs +5 -6
- package/types/document-structure-schema.mjs +20 -8
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"agents/detail-regenerator.yaml",
|
|
67
67
|
"agents/retranslate.yaml",
|
|
68
68
|
"agents/team-publish-docs.yaml",
|
|
69
|
-
"agents/
|
|
69
|
+
"agents/prefs/index.mjs"
|
|
70
70
|
]
|
|
71
71
|
},
|
|
72
72
|
{
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
"parentId": "/configuration",
|
|
98
98
|
"sourceIds": [
|
|
99
99
|
"utils/preferences-utils.mjs",
|
|
100
|
-
"agents/
|
|
100
|
+
"agents/prefs/index.mjs",
|
|
101
101
|
"prompts/feedback-refiner.md"
|
|
102
102
|
]
|
|
103
103
|
},
|
|
@@ -1,40 +1,43 @@
|
|
|
1
1
|
rules:
|
|
2
|
-
- id: pref_0e628173a762f68f
|
|
3
|
-
active: true
|
|
4
|
-
scope: document
|
|
5
|
-
rule: When specifying Claude models, must use the format `anthropic:claude-3-5-sonnet`.
|
|
6
|
-
feedback: Claude models need to be specified like this anthropic:claude-3-5-sonnet
|
|
7
|
-
createdAt: 2025-09-07T02:27:18.528Z
|
|
8
2
|
- id: pref_6e612d7ca8b7f3b6
|
|
9
3
|
active: true
|
|
10
4
|
scope: document
|
|
11
|
-
rule: When describing publishing options, should use plain text instead of custom components, and recommend users to run
|
|
12
|
-
|
|
5
|
+
rule: When describing publishing options, should use plain text instead of custom components, and recommend users to run
|
|
6
|
+
their own Discuss Kit instance while providing relevant links.
|
|
7
|
+
feedback: "Publishing options should not use custom components: recommend users to run their own Discuss Kit instance in
|
|
8
|
+
the text, and add Discuss Kit related links"
|
|
13
9
|
createdAt: 2025-09-07T02:18:22.237Z
|
|
14
10
|
- id: pref_039b58c47bdf95c9
|
|
15
11
|
active: true
|
|
16
12
|
scope: document
|
|
17
|
-
rule: In the "Prerequisites" section, should briefly introduce Node.js installation, specify using npm instead of pnpm,
|
|
18
|
-
|
|
13
|
+
rule: In the "Prerequisites" section, should briefly introduce Node.js installation, specify using npm instead of pnpm,
|
|
14
|
+
and guide users to the official website for detailed instructions.
|
|
15
|
+
feedback: In the prerequisites section, provide a simple introduction on how to install Node.js, no need to install pnpm
|
|
16
|
+
but use npm instead, guide users to the product official website for detailed installation instructions
|
|
19
17
|
createdAt: 2025-09-07T02:06:39.559Z
|
|
20
18
|
- id: pref_03a45a593f645ce2
|
|
21
19
|
active: true
|
|
22
20
|
scope: document
|
|
23
|
-
rule: When describing Discuss Kit, must clearly state that it is a non-open-source service running on the official
|
|
24
|
-
|
|
21
|
+
rule: When describing Discuss Kit, must clearly state that it is a non-open-source service running on the official
|
|
22
|
+
platform, not a self-hosted instance.
|
|
23
|
+
feedback: "In the core features description about document publishing, show the official platform link, run your own
|
|
24
|
+
Discuss Kit instance, not self-hosted: Discuss Kit is not open source."
|
|
25
25
|
createdAt: 2025-09-07T01:59:12.876Z
|
|
26
26
|
- id: pref_0c239f619329089f
|
|
27
27
|
active: true
|
|
28
28
|
scope: document
|
|
29
|
-
rule:
|
|
30
|
-
|
|
29
|
+
rule: In the core features section, should use plain list format and add descriptions and links for AIGNE Hub and
|
|
30
|
+
Discuss Kit.
|
|
31
|
+
feedback: Core features section should not use custom component lists, change to plain lists, add descriptions and links
|
|
32
|
+
for AIGNE Hub and Discuss Kit to help users understand these two products
|
|
31
33
|
createdAt: 2025-09-07T01:53:22.969Z
|
|
32
34
|
paths:
|
|
33
35
|
- /overview
|
|
34
36
|
- id: pref_4e8aa735b11d8484
|
|
35
37
|
active: true
|
|
36
38
|
scope: document
|
|
37
|
-
rule:
|
|
39
|
+
rule: In the 'How It Works' document, only show DocSmith implementation details, should not include AIGNE Framework
|
|
40
|
+
information.
|
|
38
41
|
feedback: How it works section does not need to show AIGNE Framework, only need to show DocSmith implementation
|
|
39
42
|
createdAt: 2025-09-06T13:15:10.272Z
|
|
40
43
|
paths:
|
|
@@ -42,14 +45,17 @@ rules:
|
|
|
42
45
|
- id: pref_4ad26164f1f4fbf6
|
|
43
46
|
active: true
|
|
44
47
|
scope: document
|
|
45
|
-
rule: When describing multi-language support features, must clearly state support for 12 languages and list two to three
|
|
46
|
-
|
|
48
|
+
rule: When describing multi-language support features, must clearly state support for 12 languages and list two to three
|
|
49
|
+
mainstream languages as examples.
|
|
50
|
+
feedback: Multi-language support related features, clearly support 12 languages, no above statement, and give examples
|
|
51
|
+
of two or three mainstream languages
|
|
47
52
|
createdAt: 2025-09-06T12:55:42.678Z
|
|
48
53
|
- id: pref_c84baec514ca5c60
|
|
49
54
|
active: true
|
|
50
55
|
scope: document
|
|
51
56
|
rule: Core features list must describe product functionality characteristics, not promotional value or importance.
|
|
52
|
-
feedback: Core features list should describe DocSmith's functional characteristics, not describe product importance like
|
|
57
|
+
feedback: Core features list should describe DocSmith's functional characteristics, not describe product importance like
|
|
58
|
+
a promotional brochure
|
|
53
59
|
createdAt: 2025-09-06T12:47:46.583Z
|
|
54
60
|
- id: pref_6da200d8e6fec09e
|
|
55
61
|
active: true
|
|
@@ -72,6 +78,8 @@ rules:
|
|
|
72
78
|
- id: pref_0112657e4103ba88
|
|
73
79
|
active: true
|
|
74
80
|
scope: structure
|
|
75
|
-
rule: Update documentation structure based on the latest source code, can add new documents and modify document
|
|
76
|
-
|
|
81
|
+
rule: Update documentation structure based on the latest source code, can add new documents and modify document
|
|
82
|
+
dependencies on source code, but prohibit modifying any existing document paths.
|
|
83
|
+
feedback: Update documentation structure based on the latest source code, allow adding new documents and modifying
|
|
84
|
+
document dependencies on source code, cannot modify existing document paths
|
|
77
85
|
createdAt: 2025-08-30T14:03:47.434Z
|