@aigne/doc-smith 0.8.11-beta.5 → 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.
Files changed (159) hide show
  1. package/.aigne/doc-smith/config.yaml +3 -1
  2. package/.aigne/doc-smith/output/structure-plan.json +2 -2
  3. package/.aigne/doc-smith/preferences.yml +28 -20
  4. package/.aigne/doc-smith/upload-cache.yaml +702 -0
  5. package/.release-please-manifest.json +1 -1
  6. package/CHANGELOG.md +22 -2
  7. package/README.md +2 -2
  8. package/agents/clear/choose-contents.mjs +2 -2
  9. package/agents/clear/clear-document-structure.mjs +8 -8
  10. package/agents/clear/index.yaml +1 -1
  11. package/agents/evaluate/document-structure.yaml +1 -1
  12. package/agents/generate/check-document-structure.yaml +3 -3
  13. package/agents/generate/check-need-generate-structure.mjs +8 -8
  14. package/agents/generate/document-structure-tools/add-document.mjs +38 -13
  15. package/agents/generate/document-structure-tools/delete-document.mjs +37 -14
  16. package/agents/generate/document-structure-tools/move-document.mjs +46 -19
  17. package/agents/generate/document-structure-tools/update-document.mjs +39 -12
  18. package/agents/generate/generate-structure.yaml +1 -1
  19. package/agents/generate/update-document-structure.yaml +3 -9
  20. package/agents/generate/user-review-document-structure.mjs +15 -14
  21. package/agents/translate/translate-document.yaml +1 -9
  22. package/agents/update/batch-generate-document.yaml +1 -1
  23. package/agents/update/check-document.mjs +2 -2
  24. package/agents/update/check-update-is-single.mjs +2 -1
  25. package/agents/update/document-tools/update-document-content.mjs +24 -14
  26. package/agents/update/fs-tools/glob.mjs +184 -0
  27. package/agents/update/fs-tools/grep.mjs +317 -0
  28. package/agents/update/fs-tools/read-file.mjs +307 -0
  29. package/agents/update/generate-document.yaml +4 -7
  30. package/agents/update/update-document-detail.yaml +6 -10
  31. package/agents/update/user-review-document.mjs +13 -13
  32. package/agents/utils/check-feedback-refiner.mjs +1 -1
  33. package/agents/utils/choose-docs.mjs +1 -1
  34. package/agents/utils/load-document-all-content.mjs +3 -3
  35. package/agents/utils/load-sources.mjs +1 -1
  36. package/agents/utils/save-docs.mjs +7 -28
  37. package/aigne.yaml +2 -2
  38. package/assets/screenshots/doc-complete-setup.png +0 -0
  39. package/assets/screenshots/doc-generate-docs.png +0 -0
  40. package/assets/screenshots/doc-generate.png +0 -0
  41. package/assets/screenshots/doc-generated-successfully.png +0 -0
  42. package/assets/screenshots/doc-publish.png +0 -0
  43. package/assets/screenshots/doc-regenerate.png +0 -0
  44. package/assets/screenshots/doc-translate-langs.png +0 -0
  45. package/assets/screenshots/doc-translate.png +0 -0
  46. package/assets/screenshots/doc-update.png +0 -0
  47. package/docs/_sidebar.md +1 -1
  48. package/docs/advanced-how-it-works.ja.md +31 -31
  49. package/docs/advanced-how-it-works.md +10 -10
  50. package/docs/advanced-how-it-works.zh-TW.md +24 -24
  51. package/docs/advanced-how-it-works.zh.md +20 -20
  52. package/docs/advanced-quality-assurance.ja.md +57 -61
  53. package/docs/advanced-quality-assurance.md +57 -61
  54. package/docs/advanced-quality-assurance.zh-TW.md +57 -61
  55. package/docs/advanced-quality-assurance.zh.md +57 -61
  56. package/docs/advanced.ja.md +8 -4
  57. package/docs/advanced.md +7 -3
  58. package/docs/advanced.zh-TW.md +9 -5
  59. package/docs/advanced.zh.md +9 -5
  60. package/docs/changelog.ja.md +206 -29
  61. package/docs/changelog.md +177 -0
  62. package/docs/changelog.zh-TW.md +229 -52
  63. package/docs/changelog.zh.md +204 -27
  64. package/docs/cli-reference.ja.md +181 -80
  65. package/docs/cli-reference.md +168 -67
  66. package/docs/cli-reference.zh-TW.md +177 -76
  67. package/docs/cli-reference.zh.md +172 -71
  68. package/docs/configuration-interactive-setup.ja.md +45 -42
  69. package/docs/configuration-interactive-setup.md +9 -6
  70. package/docs/configuration-interactive-setup.zh-TW.md +26 -23
  71. package/docs/configuration-interactive-setup.zh.md +25 -22
  72. package/docs/configuration-language-support.ja.md +33 -63
  73. package/docs/configuration-language-support.md +32 -62
  74. package/docs/configuration-language-support.zh-TW.md +35 -65
  75. package/docs/configuration-language-support.zh.md +32 -62
  76. package/docs/configuration-llm-setup.ja.md +25 -23
  77. package/docs/configuration-llm-setup.md +20 -18
  78. package/docs/configuration-llm-setup.zh-TW.md +21 -19
  79. package/docs/configuration-llm-setup.zh.md +20 -18
  80. package/docs/configuration-preferences.ja.md +67 -52
  81. package/docs/configuration-preferences.md +55 -40
  82. package/docs/configuration-preferences.zh-TW.md +69 -54
  83. package/docs/configuration-preferences.zh.md +68 -53
  84. package/docs/configuration.ja.md +98 -58
  85. package/docs/configuration.md +42 -2
  86. package/docs/configuration.zh-TW.md +86 -46
  87. package/docs/configuration.zh.md +76 -36
  88. package/docs/features-generate-documentation.ja.md +49 -55
  89. package/docs/features-generate-documentation.md +49 -55
  90. package/docs/features-generate-documentation.zh-TW.md +54 -60
  91. package/docs/features-generate-documentation.zh.md +48 -54
  92. package/docs/features-publish-your-docs.ja.md +68 -45
  93. package/docs/features-publish-your-docs.md +65 -42
  94. package/docs/features-publish-your-docs.zh-TW.md +74 -51
  95. package/docs/features-publish-your-docs.zh.md +67 -44
  96. package/docs/features-translate-documentation.ja.md +46 -35
  97. package/docs/features-translate-documentation.md +39 -28
  98. package/docs/features-translate-documentation.zh-TW.md +45 -34
  99. package/docs/features-translate-documentation.zh.md +39 -28
  100. package/docs/features-update-and-refine.ja.md +75 -71
  101. package/docs/features-update-and-refine.md +67 -63
  102. package/docs/features-update-and-refine.zh-TW.md +72 -67
  103. package/docs/features-update-and-refine.zh.md +71 -67
  104. package/docs/features.ja.md +29 -19
  105. package/docs/features.md +25 -15
  106. package/docs/features.zh-TW.md +28 -18
  107. package/docs/features.zh.md +31 -21
  108. package/docs/getting-started.ja.md +43 -46
  109. package/docs/getting-started.md +36 -39
  110. package/docs/getting-started.zh-TW.md +41 -44
  111. package/docs/getting-started.zh.md +39 -42
  112. package/docs/overview.ja.md +63 -11
  113. package/docs/overview.md +62 -10
  114. package/docs/overview.zh-TW.md +67 -15
  115. package/docs/overview.zh.md +62 -10
  116. package/docs-mcp/analyze-docs-relevance.yaml +6 -6
  117. package/docs-mcp/docs-search.yaml +1 -1
  118. package/media.md +9 -9
  119. package/package.json +2 -2
  120. package/prompts/common/document-structure/conflict-resolution-guidance.md +3 -3
  121. package/prompts/common/document-structure/document-structure-rules.md +2 -2
  122. package/prompts/detail/custom/custom-components.md +304 -188
  123. package/prompts/detail/document-rules.md +5 -5
  124. package/prompts/detail/generate-document.md +21 -8
  125. package/prompts/detail/update-document.md +8 -12
  126. package/prompts/evaluate/document-structure.md +6 -6
  127. package/prompts/structure/check-document-structure.md +10 -10
  128. package/prompts/structure/document-rules.md +2 -2
  129. package/prompts/structure/generate-structure-system.md +3 -3
  130. package/prompts/structure/structure-example.md +1 -1
  131. package/prompts/structure/structure-getting-started.md +1 -1
  132. package/prompts/structure/update-document-structure.md +18 -14
  133. package/prompts/utils/feedback-refiner.md +3 -3
  134. package/tests/agents/clear/choose-contents.test.mjs +1 -1
  135. package/tests/agents/clear/clear-document-structure.test.mjs +36 -30
  136. package/tests/agents/evaluate/generate-report.test.mjs +1 -1
  137. package/tests/agents/generate/check-need-generate-structure.test.mjs +1 -1
  138. package/tests/agents/generate/document-structure-tools/add-document.test.mjs +2 -2
  139. package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +4 -4
  140. package/tests/agents/generate/document-structure-tools/move-document.test.mjs +12 -12
  141. package/tests/agents/generate/document-structure-tools/update-document.test.mjs +3 -3
  142. package/tests/agents/generate/user-review-document-structure.test.mjs +36 -13
  143. package/tests/agents/update/check-document.test.mjs +1 -1
  144. package/tests/agents/update/document-tools/update-document-content.test.mjs +115 -112
  145. package/tests/agents/update/fs-tools/glob.test.mjs +438 -0
  146. package/tests/agents/update/fs-tools/grep.test.mjs +279 -0
  147. package/tests/agents/update/fs-tools/read-file.test.mjs +553 -0
  148. package/tests/agents/update/user-review-document.test.mjs +48 -27
  149. package/tests/agents/utils/format-document-structure.test.mjs +5 -5
  150. package/tests/agents/utils/load-sources.test.mjs +4 -4
  151. package/tests/agents/utils/save-docs.test.mjs +1 -1
  152. package/tests/utils/conflict-detector.test.mjs +1 -1
  153. package/tests/utils/docs-finder-utils.test.mjs +8 -8
  154. package/types/document-schema.mjs +5 -6
  155. package/types/document-structure-schema.mjs +25 -13
  156. package/utils/conflict-detector.mjs +1 -1
  157. package/utils/constants/index.mjs +4 -4
  158. package/utils/docs-finder-utils.mjs +11 -11
  159. package/utils/markdown-checker.mjs +1 -1
@@ -66,7 +66,9 @@ translateLanguages:
66
66
  docsDir: ./docs # Directory to save generated documentation
67
67
  sourcesPath: # Source code paths to analyze
68
68
  - ./
69
- lastGitHead: f3f14b93e6b2e6beb42b2f368c2560ab050dfd03
69
+ lastGitHead: 6fc5d715e778663896ae179975ec72d9e5ff97ed
70
70
  # ⚠️ Warning: boardId is auto-generated by system, please do not edit manually
71
71
  boardId: "docsmith"
72
72
  appUrl: https://docsmith.aigne.io
73
+ # Checkout ID for document deployment service
74
+ checkoutId: ""
@@ -66,7 +66,7 @@
66
66
  "agents/detail-regenerator.yaml",
67
67
  "agents/retranslate.yaml",
68
68
  "agents/team-publish-docs.yaml",
69
- "agents/manage-prefs.mjs"
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/manage-prefs.mjs",
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 their own Discuss Kit instance while providing relevant links.
12
- feedback: "Publishing options should not use custom components: recommend users to run their own Discuss Kit instance in the text, and add Discuss Kit related links"
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, and guide users to the official website for detailed instructions.
18
- feedback: "In the prerequisites section, provide a simple introduction on how to install Node.js, no need to install pnpm but use npm instead, guide users to the product official website for detailed installation instructions"
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 platform, not a self-hosted instance.
24
- feedback: "In the core features description about document publishing, show the official platform link, run your own Discuss Kit instance, not self-hosted: Discuss Kit is not open source."
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: "In the core features section, should use plain list format and add descriptions and links for AIGNE Hub and Discuss Kit."
30
- feedback: Core features section should not use custom component lists, change to plain lists, add descriptions and links for AIGNE Hub and Discuss Kit to help users understand these two products
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: "In the 'How It Works' document, only show DocSmith implementation details, should not include AIGNE Framework information."
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 mainstream languages as examples.
46
- feedback: Multi-language support related features, clearly support 12 languages, no above statement, and give examples of two or three mainstream languages
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 a promotional brochure
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 dependencies on source code, but prohibit modifying any existing document paths.
76
- feedback: Update documentation structure based on the latest source code, allow adding new documents and modifying document dependencies on source code, cannot modify existing document paths
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