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

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 (264) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/agents/publish/index.yaml +4 -0
  3. package/agents/publish/publish-docs.mjs +77 -5
  4. package/agents/publish/translate-meta.mjs +103 -0
  5. package/agents/update/generate-document.yaml +30 -28
  6. package/agents/update/update-document-detail.yaml +3 -1
  7. package/agents/utils/update-branding.mjs +69 -0
  8. package/package.json +16 -2
  9. package/prompts/common/document/role-and-personality.md +3 -1
  10. package/prompts/detail/d2-diagram/guide.md +7 -1
  11. package/prompts/detail/d2-diagram/user-prompt.md +3 -0
  12. package/prompts/detail/generate/system-prompt.md +6 -7
  13. package/prompts/detail/generate/user-prompt.md +12 -3
  14. package/prompts/detail/update/user-prompt.md +0 -2
  15. package/prompts/structure/update/user-prompt.md +0 -4
  16. package/utils/file-utils.mjs +69 -24
  17. package/utils/markdown-checker.mjs +0 -20
  18. package/utils/request.mjs +7 -0
  19. package/utils/upload-files.mjs +231 -0
  20. package/utils/utils.mjs +11 -1
  21. package/.aigne/doc-smith/config.yaml +0 -77
  22. package/.aigne/doc-smith/history.yaml +0 -37
  23. package/.aigne/doc-smith/media-description.yaml +0 -91
  24. package/.aigne/doc-smith/output/structure-plan.json +0 -162
  25. package/.aigne/doc-smith/preferences.yml +0 -97
  26. package/.aigne/doc-smith/upload-cache.yaml +0 -1830
  27. package/.github/PULL_REQUEST_TEMPLATE.md +0 -28
  28. package/.github/workflows/ci.yml +0 -54
  29. package/.github/workflows/create-release-pr.yaml +0 -21
  30. package/.github/workflows/publish-docs.yml +0 -65
  31. package/.github/workflows/release.yml +0 -49
  32. package/.github/workflows/reviewer.yml +0 -54
  33. package/.release-please-manifest.json +0 -3
  34. package/RELEASE.md +0 -9
  35. package/assets/screenshots/doc-complete-setup.png +0 -0
  36. package/assets/screenshots/doc-generate-docs.png +0 -0
  37. package/assets/screenshots/doc-generate.png +0 -0
  38. package/assets/screenshots/doc-generated-successfully.png +0 -0
  39. package/assets/screenshots/doc-publish.png +0 -0
  40. package/assets/screenshots/doc-regenerate.png +0 -0
  41. package/assets/screenshots/doc-translate-langs.png +0 -0
  42. package/assets/screenshots/doc-translate.png +0 -0
  43. package/assets/screenshots/doc-update.png +0 -0
  44. package/biome.json +0 -73
  45. package/codecov.yml +0 -15
  46. package/docs/_sidebar.md +0 -15
  47. package/docs/configuration-initial-setup.ja.md +0 -179
  48. package/docs/configuration-initial-setup.md +0 -198
  49. package/docs/configuration-initial-setup.zh-TW.md +0 -179
  50. package/docs/configuration-initial-setup.zh.md +0 -179
  51. package/docs/configuration-managing-preferences.ja.md +0 -100
  52. package/docs/configuration-managing-preferences.md +0 -100
  53. package/docs/configuration-managing-preferences.zh-TW.md +0 -100
  54. package/docs/configuration-managing-preferences.zh.md +0 -100
  55. package/docs/configuration.ja.md +0 -69
  56. package/docs/configuration.md +0 -69
  57. package/docs/configuration.zh-TW.md +0 -69
  58. package/docs/configuration.zh.md +0 -69
  59. package/docs/getting-started.ja.md +0 -107
  60. package/docs/getting-started.md +0 -107
  61. package/docs/getting-started.zh-TW.md +0 -107
  62. package/docs/getting-started.zh.md +0 -107
  63. package/docs/guides-cleaning-up.ja.md +0 -51
  64. package/docs/guides-cleaning-up.md +0 -52
  65. package/docs/guides-cleaning-up.zh-TW.md +0 -51
  66. package/docs/guides-cleaning-up.zh.md +0 -51
  67. package/docs/guides-evaluating-documents.ja.md +0 -66
  68. package/docs/guides-evaluating-documents.md +0 -107
  69. package/docs/guides-evaluating-documents.zh-TW.md +0 -66
  70. package/docs/guides-evaluating-documents.zh.md +0 -66
  71. package/docs/guides-generating-documentation.ja.md +0 -151
  72. package/docs/guides-generating-documentation.md +0 -89
  73. package/docs/guides-generating-documentation.zh-TW.md +0 -151
  74. package/docs/guides-generating-documentation.zh.md +0 -151
  75. package/docs/guides-interactive-chat.ja.md +0 -85
  76. package/docs/guides-interactive-chat.md +0 -93
  77. package/docs/guides-interactive-chat.zh-TW.md +0 -85
  78. package/docs/guides-interactive-chat.zh.md +0 -85
  79. package/docs/guides-managing-history.ja.md +0 -48
  80. package/docs/guides-managing-history.md +0 -53
  81. package/docs/guides-managing-history.zh-TW.md +0 -48
  82. package/docs/guides-managing-history.zh.md +0 -48
  83. package/docs/guides-publishing-your-docs.ja.md +0 -78
  84. package/docs/guides-publishing-your-docs.md +0 -83
  85. package/docs/guides-publishing-your-docs.zh-TW.md +0 -78
  86. package/docs/guides-publishing-your-docs.zh.md +0 -78
  87. package/docs/guides-translating-documentation.ja.md +0 -95
  88. package/docs/guides-translating-documentation.md +0 -100
  89. package/docs/guides-translating-documentation.zh-TW.md +0 -95
  90. package/docs/guides-translating-documentation.zh.md +0 -95
  91. package/docs/guides-updating-documentation.ja.md +0 -77
  92. package/docs/guides-updating-documentation.md +0 -79
  93. package/docs/guides-updating-documentation.zh-TW.md +0 -77
  94. package/docs/guides-updating-documentation.zh.md +0 -77
  95. package/docs/guides.ja.md +0 -32
  96. package/docs/guides.md +0 -32
  97. package/docs/guides.zh-TW.md +0 -32
  98. package/docs/guides.zh.md +0 -32
  99. package/docs/overview.ja.md +0 -61
  100. package/docs/overview.md +0 -61
  101. package/docs/overview.zh-TW.md +0 -61
  102. package/docs/overview.zh.md +0 -61
  103. package/docs/release-notes.ja.md +0 -255
  104. package/docs/release-notes.md +0 -288
  105. package/docs/release-notes.zh-TW.md +0 -255
  106. package/docs/release-notes.zh.md +0 -255
  107. package/prompts/common/afs/afs-tools-usage.md +0 -5
  108. package/prompts/common/afs/use-afs-instruction.md +0 -1
  109. package/release-please-config.json +0 -14
  110. package/tests/agents/chat/chat.test.mjs +0 -46
  111. package/tests/agents/clear/choose-contents.test.mjs +0 -284
  112. package/tests/agents/clear/clear-auth-tokens.test.mjs +0 -268
  113. package/tests/agents/clear/clear-document-config.test.mjs +0 -167
  114. package/tests/agents/clear/clear-document-structure.test.mjs +0 -380
  115. package/tests/agents/clear/clear-generated-docs.test.mjs +0 -222
  116. package/tests/agents/evaluate/code-snippet.test.mjs +0 -163
  117. package/tests/agents/evaluate/fixtures/api-services.md +0 -87
  118. package/tests/agents/evaluate/fixtures/js-sdk.md +0 -94
  119. package/tests/agents/evaluate/generate-report.test.mjs +0 -312
  120. package/tests/agents/generate/check-document-structure.test.mjs +0 -45
  121. package/tests/agents/generate/check-need-generate-structure.test.mjs +0 -279
  122. package/tests/agents/generate/document-structure-tools/add-document.test.mjs +0 -449
  123. package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +0 -410
  124. package/tests/agents/generate/document-structure-tools/generate-sub-structure.test.mjs +0 -277
  125. package/tests/agents/generate/document-structure-tools/move-document.test.mjs +0 -476
  126. package/tests/agents/generate/document-structure-tools/update-document.test.mjs +0 -548
  127. package/tests/agents/generate/generate-structure.test.mjs +0 -45
  128. package/tests/agents/generate/user-review-document-structure.test.mjs +0 -319
  129. package/tests/agents/history/view.test.mjs +0 -97
  130. package/tests/agents/init/init.test.mjs +0 -1657
  131. package/tests/agents/prefs/prefs.test.mjs +0 -431
  132. package/tests/agents/publish/publish-docs.test.mjs +0 -787
  133. package/tests/agents/translate/choose-language.test.mjs +0 -311
  134. package/tests/agents/translate/translate-document.test.mjs +0 -51
  135. package/tests/agents/update/check-document.test.mjs +0 -463
  136. package/tests/agents/update/check-update-is-single.test.mjs +0 -300
  137. package/tests/agents/update/document-tools/update-document-content.test.mjs +0 -329
  138. package/tests/agents/update/generate-document.test.mjs +0 -51
  139. package/tests/agents/update/save-and-translate-document.test.mjs +0 -369
  140. package/tests/agents/update/user-review-document.test.mjs +0 -582
  141. package/tests/agents/utils/action-success.test.mjs +0 -54
  142. package/tests/agents/utils/check-detail-result.test.mjs +0 -743
  143. package/tests/agents/utils/check-feedback-refiner.test.mjs +0 -478
  144. package/tests/agents/utils/choose-docs.test.mjs +0 -406
  145. package/tests/agents/utils/exit.test.mjs +0 -70
  146. package/tests/agents/utils/feedback-refiner.test.mjs +0 -51
  147. package/tests/agents/utils/find-item-by-path.test.mjs +0 -517
  148. package/tests/agents/utils/find-user-preferences-by-path.test.mjs +0 -382
  149. package/tests/agents/utils/format-document-structure.test.mjs +0 -364
  150. package/tests/agents/utils/fs.test.mjs +0 -267
  151. package/tests/agents/utils/load-sources.test.mjs +0 -1470
  152. package/tests/agents/utils/save-docs.test.mjs +0 -109
  153. package/tests/agents/utils/save-output.test.mjs +0 -315
  154. package/tests/agents/utils/save-single-doc.test.mjs +0 -364
  155. package/tests/agents/utils/transform-detail-datasources.test.mjs +0 -320
  156. package/tests/utils/auth-utils.test.mjs +0 -596
  157. package/tests/utils/blocklet.test.mjs +0 -336
  158. package/tests/utils/conflict-detector.test.mjs +0 -355
  159. package/tests/utils/constants.test.mjs +0 -295
  160. package/tests/utils/d2-utils.test.mjs +0 -437
  161. package/tests/utils/deploy.test.mjs +0 -399
  162. package/tests/utils/docs-finder-utils.test.mjs +0 -650
  163. package/tests/utils/file-utils.test.mjs +0 -521
  164. package/tests/utils/history-utils.test.mjs +0 -206
  165. package/tests/utils/kroki-utils.test.mjs +0 -646
  166. package/tests/utils/linter/fixtures/css/keyword-error.css +0 -1
  167. package/tests/utils/linter/fixtures/css/missing-semicolon.css +0 -1
  168. package/tests/utils/linter/fixtures/css/syntax-error.css +0 -1
  169. package/tests/utils/linter/fixtures/css/undeclare-variable.css +0 -1
  170. package/tests/utils/linter/fixtures/css/unused-variable.css +0 -2
  171. package/tests/utils/linter/fixtures/css/valid-code.css +0 -1
  172. package/tests/utils/linter/fixtures/dockerfile/keyword-error.dockerfile +0 -1
  173. package/tests/utils/linter/fixtures/dockerfile/missing-semicolon.dockerfile +0 -2
  174. package/tests/utils/linter/fixtures/dockerfile/syntax-error.dockerfile +0 -2
  175. package/tests/utils/linter/fixtures/dockerfile/undeclare-variable.dockerfile +0 -1
  176. package/tests/utils/linter/fixtures/dockerfile/unused-variable.dockerfile +0 -1
  177. package/tests/utils/linter/fixtures/dockerfile/valid-code.dockerfile +0 -2
  178. package/tests/utils/linter/fixtures/go/keyword-error.go +0 -5
  179. package/tests/utils/linter/fixtures/go/missing-semicolon.go +0 -5
  180. package/tests/utils/linter/fixtures/go/syntax-error.go +0 -6
  181. package/tests/utils/linter/fixtures/go/undeclare-variable.go +0 -5
  182. package/tests/utils/linter/fixtures/go/unused-variable.go +0 -5
  183. package/tests/utils/linter/fixtures/go/valid-code.go +0 -7
  184. package/tests/utils/linter/fixtures/js/keyword-error.js +0 -3
  185. package/tests/utils/linter/fixtures/js/missing-semicolon.js +0 -6
  186. package/tests/utils/linter/fixtures/js/syntax-error.js +0 -4
  187. package/tests/utils/linter/fixtures/js/undeclare-variable.js +0 -3
  188. package/tests/utils/linter/fixtures/js/unused-variable.js +0 -7
  189. package/tests/utils/linter/fixtures/js/valid-code.js +0 -15
  190. package/tests/utils/linter/fixtures/json/keyword-error.json +0 -1
  191. package/tests/utils/linter/fixtures/json/missing-semicolon.json +0 -1
  192. package/tests/utils/linter/fixtures/json/syntax-error.json +0 -1
  193. package/tests/utils/linter/fixtures/json/undeclare-variable.json +0 -1
  194. package/tests/utils/linter/fixtures/json/unused-variable.json +0 -1
  195. package/tests/utils/linter/fixtures/json/valid-code.json +0 -1
  196. package/tests/utils/linter/fixtures/jsx/keyword-error.jsx +0 -5
  197. package/tests/utils/linter/fixtures/jsx/missing-semicolon.jsx +0 -5
  198. package/tests/utils/linter/fixtures/jsx/syntax-error.jsx +0 -5
  199. package/tests/utils/linter/fixtures/jsx/undeclare-variable.jsx +0 -5
  200. package/tests/utils/linter/fixtures/jsx/unused-variable.jsx +0 -4
  201. package/tests/utils/linter/fixtures/jsx/valid-code.jsx +0 -5
  202. package/tests/utils/linter/fixtures/python/keyword-error.py +0 -3
  203. package/tests/utils/linter/fixtures/python/missing-semicolon.py +0 -2
  204. package/tests/utils/linter/fixtures/python/syntax-error.py +0 -3
  205. package/tests/utils/linter/fixtures/python/undeclare-variable.py +0 -3
  206. package/tests/utils/linter/fixtures/python/unused-variable.py +0 -6
  207. package/tests/utils/linter/fixtures/python/valid-code.py +0 -12
  208. package/tests/utils/linter/fixtures/ruby/keyword-error.rb +0 -2
  209. package/tests/utils/linter/fixtures/ruby/missing-semicolon.rb +0 -1
  210. package/tests/utils/linter/fixtures/ruby/syntax-error.rb +0 -2
  211. package/tests/utils/linter/fixtures/ruby/undeclare-variable.rb +0 -1
  212. package/tests/utils/linter/fixtures/ruby/unused-variable.rb +0 -2
  213. package/tests/utils/linter/fixtures/ruby/valid-code.rb +0 -1
  214. package/tests/utils/linter/fixtures/sass/keyword-error.sass +0 -2
  215. package/tests/utils/linter/fixtures/sass/missing-semicolon.sass +0 -3
  216. package/tests/utils/linter/fixtures/sass/syntax-error.sass +0 -3
  217. package/tests/utils/linter/fixtures/sass/undeclare-variable.sass +0 -2
  218. package/tests/utils/linter/fixtures/sass/unused-variable.sass +0 -4
  219. package/tests/utils/linter/fixtures/sass/valid-code.sass +0 -2
  220. package/tests/utils/linter/fixtures/scss/keyword-error.scss +0 -1
  221. package/tests/utils/linter/fixtures/scss/missing-semicolon.scss +0 -1
  222. package/tests/utils/linter/fixtures/scss/syntax-error.scss +0 -1
  223. package/tests/utils/linter/fixtures/scss/undeclare-variable.scss +0 -1
  224. package/tests/utils/linter/fixtures/scss/unused-variable.scss +0 -2
  225. package/tests/utils/linter/fixtures/scss/valid-code.scss +0 -1
  226. package/tests/utils/linter/fixtures/shell/keyword-error.sh +0 -5
  227. package/tests/utils/linter/fixtures/shell/missing-semicolon.sh +0 -3
  228. package/tests/utils/linter/fixtures/shell/syntax-error.sh +0 -4
  229. package/tests/utils/linter/fixtures/shell/undeclare-variable.sh +0 -3
  230. package/tests/utils/linter/fixtures/shell/unused-variable.sh +0 -4
  231. package/tests/utils/linter/fixtures/shell/valid-code.sh +0 -3
  232. package/tests/utils/linter/fixtures/ts/keyword-error.ts +0 -1
  233. package/tests/utils/linter/fixtures/ts/missing-semicolon.ts +0 -1
  234. package/tests/utils/linter/fixtures/ts/syntax-error.ts +0 -1
  235. package/tests/utils/linter/fixtures/ts/undeclare-variable.ts +0 -1
  236. package/tests/utils/linter/fixtures/ts/unused-variable.ts +0 -3
  237. package/tests/utils/linter/fixtures/ts/valid-code.ts +0 -3
  238. package/tests/utils/linter/fixtures/tsx/keyword-error.tsx +0 -5
  239. package/tests/utils/linter/fixtures/tsx/missing-semicolon.tsx +0 -5
  240. package/tests/utils/linter/fixtures/tsx/syntax-error.tsx +0 -5
  241. package/tests/utils/linter/fixtures/tsx/undeclare-variable.tsx +0 -6
  242. package/tests/utils/linter/fixtures/tsx/unused-variable.tsx +0 -6
  243. package/tests/utils/linter/fixtures/tsx/valid-code.tsx +0 -5
  244. package/tests/utils/linter/fixtures/vue/keyword-error.vue +0 -6
  245. package/tests/utils/linter/fixtures/vue/missing-semicolon.vue +0 -6
  246. package/tests/utils/linter/fixtures/vue/syntax-error.vue +0 -6
  247. package/tests/utils/linter/fixtures/vue/undeclare-variable.vue +0 -6
  248. package/tests/utils/linter/fixtures/vue/unused-variable.vue +0 -7
  249. package/tests/utils/linter/fixtures/vue/valid-code.vue +0 -6
  250. package/tests/utils/linter/fixtures/yaml/keyword-error.yml +0 -1
  251. package/tests/utils/linter/fixtures/yaml/missing-semicolon.yml +0 -2
  252. package/tests/utils/linter/fixtures/yaml/syntax-error.yml +0 -1
  253. package/tests/utils/linter/fixtures/yaml/undeclare-variable.yml +0 -1
  254. package/tests/utils/linter/fixtures/yaml/unused-variable.yml +0 -2
  255. package/tests/utils/linter/fixtures/yaml/valid-code.yml +0 -3
  256. package/tests/utils/linter/index.test.mjs +0 -440
  257. package/tests/utils/linter/scan-results.mjs +0 -42
  258. package/tests/utils/load-config.test.mjs +0 -141
  259. package/tests/utils/markdown/index.test.mjs +0 -478
  260. package/tests/utils/mermaid-validator.test.mjs +0 -541
  261. package/tests/utils/mock-chat-model.mjs +0 -12
  262. package/tests/utils/preferences-utils.test.mjs +0 -465
  263. package/tests/utils/save-value-to-config.test.mjs +0 -483
  264. package/tests/utils/utils.test.mjs +0 -941
@@ -1,288 +0,0 @@
1
- # Release Notes
2
-
3
- This document provides a chronological record of new features, improvements, and bug fixes for each version of the tool.
4
-
5
- ## Version 0.8.12-beta.7 (2025-10-12)
6
-
7
- ### New Features
8
-
9
- - The tool can now retrieve context more effectively from the project repository, leading to more accurate documentation.
10
-
11
- ### Bug Fixes
12
-
13
- - Disabled Git-based update history tracking within repositories to prevent potential conflicts.
14
-
15
- ## Version 0.8.12-beta.6 (2025-10-11)
16
-
17
- ### Bug Fixes
18
-
19
- - Improved the reliability of the publishing process by enhancing login session checks.
20
-
21
- ## Version 0.8.12-beta.5 (2025-10-11)
22
-
23
- ### Bug Fixes
24
-
25
- - Fixed a bug where the correct language setting was not applied during document checks.
26
-
27
- ## Version 0.8.12-beta.4 (2025-10-11)
28
-
29
- ### New Features
30
-
31
- - Introduced optimizations for handling large projects, resulting in more efficient document generation.
32
-
33
- ### Bug Fixes
34
-
35
- - Ensured that generated documents follow a strict heading hierarchy (e.g., no skipping from H1 to H3).
36
- - Improved the clarity of update notifications and added an option to clear deployment configurations.
37
-
38
- ## Version 0.8.12-beta.3 (2025-10-09)
39
-
40
- ### Bug Fixes
41
-
42
- - Resolved an issue where publishing to the cloud incorrectly required administrator permissions.
43
-
44
- ## Version 0.8.12-beta.2 (2025-10-09)
45
-
46
- ### Bug Fixes
47
-
48
- - Corrected an error with file path resolution when updating documents.
49
- - Fixed an issue that could cause document generation and updates to fail.
50
-
51
- ## Version 0.8.12-beta.1 (2025-10-08)
52
-
53
- ### New Features
54
-
55
- - Introduced history tracking, allowing you to view past changes to your documents.
56
- - Made translation an optional step during the document update process for greater flexibility.
57
-
58
- ### Bug Fixes
59
-
60
- - Refined the logic for document generation and updates to distinguish between system and user prompts.
61
-
62
- ## Version 0.8.12-beta (2025-10-07)
63
-
64
- ### Bug Fixes
65
-
66
- - The internal file reading tool now correctly supports relative paths.
67
-
68
- ## Version 0.8.11 (2025-10-05)
69
-
70
- This version includes general maintenance and stability improvements.
71
-
72
- ## Version 0.8.11-beta.7 (2025-10-03)
73
-
74
- ### New Features
75
-
76
- - Enhanced the document generator and updater with improved file system tools.
77
- - Implemented a shared context mechanism to speed up document structure analysis and content refinement.
78
-
79
- ### Bug Fixes
80
-
81
- - Updated internal documentation and refined prompts for custom components to improve accuracy.
82
-
83
- ## Version 0.8.11-beta.5 (2025-10-01)
84
-
85
- ### New Features
86
-
87
- - Added support for user role requirements for publishing and custom rule configurations.
88
- - Separated D2 diagram generation into an independent tool for more focused functionality.
89
-
90
- ## Version 0.8.11-beta.4 (2025-09-30)
91
-
92
- ### New Features
93
-
94
- - Added a "check-only" option for processes that use selection inputs.
95
-
96
- ### Bug Fixes
97
-
98
- - Improved error handling in the document selection utility.
99
- - Tuned the translation prompt to ensure that only comments within code blocks are translated.
100
-
101
- ## Version 0.8.11-beta.3 (2025-09-29)
102
-
103
- ### Bug Fixes
104
-
105
- - Added a command-line interface entry for the document evaluation agents.
106
-
107
- ## Version 0.8.11-beta.2 (2025-09-27)
108
-
109
- ### Bug Fixes
110
-
111
- - Resolved dependency conflicts to ensure smoother operation.
112
-
113
- ## Version 0.8.11-beta.1 (2025-09-27)
114
-
115
- ### New Features
116
-
117
- - Introduced a document evaluation feature to generate quality reports.
118
- - Enhanced the document and structure update process with improved internal tools.
119
- - Improved vendor handling and debugging capabilities during the publishing process.
120
-
121
- ### Bug Fixes
122
-
123
- - Fixed an issue where component descriptions were incorrectly treated as attributes instead of text content, improving custom component rendering.
124
-
125
- ## Version 0.8.10 (2025-09-20)
126
-
127
- This version includes general maintenance and stability improvements.
128
-
129
- ## Version 0.8.10-beta.3 (2025-09-19)
130
-
131
- ### Bug Fixes
132
-
133
- - Added relevant links for enterprise deployment.
134
- - Polished the text for the document review prompt for better clarity.
135
-
136
- ## Version 0.8.10-beta.2 (2025-09-18)
137
-
138
- ### Bug Fixes
139
-
140
- - Improved the prompts and display for the documentation structure review feature.
141
- - Updated the usage rules for field elements to ensure correct rendering.
142
-
143
- ## Version 0.8.10-beta.1 (2025-09-18)
144
-
145
- ### New Features
146
-
147
- - Added a workflow to review the documentation structure before generation.
148
-
149
- ### Bug Fixes
150
-
151
- - Improved the consistency and clarity of English-language text in the user interface.
152
- - Updated the DocSmith logo.
153
-
154
- ## Version 0.8.9 (2025-09-15)
155
-
156
- ### Bug Fixes
157
-
158
- - Updated the theme color for D2 diagrams for better visual consistency.
159
-
160
- ## Version 0.8.8 (2025-09-13)
161
-
162
- ### Bug Fixes
163
-
164
- - Optimized the text for inquiry feedback prompts to be clearer and more helpful.
165
-
166
- ## Version 0.8.7 (2025-09-12)
167
-
168
- ### New Features
169
-
170
- - Added support for defining API parameters using the `<x-field>` custom component.
171
-
172
- ## Version 0.8.6 (2025-09-11)
173
-
174
- ### New Features
175
-
176
- - The documentation URL is now displayed by default after a successful publishing process.
177
-
178
- ### Bug Fixes
179
-
180
- - Ensured that logs are saved correctly during deployment to prevent data loss.
181
-
182
- ## Version 0.8.5 (2025-09-10)
183
-
184
- ### New Features
185
-
186
- - Added support for publishing documents to enterprise spaces.
187
-
188
- ## Version 0.8.4 (2025-09-09)
189
-
190
- ### Bug Fixes
191
-
192
- - Markdown code blocks are now parsed into a custom element with support for enhanced attributes like titles and icons.
193
- - Made the background for D2 diagrams transparent for better integration with different themes.
194
-
195
- ## Version 0.8.3 (2025-09-05)
196
-
197
- ### Bug Fixes
198
-
199
- - Added automatic dimension detection for local images to ensure they are displayed correctly.
200
-
201
- ## Version 0.8.1 (2025-09-03)
202
-
203
- ### New Features
204
-
205
- - Improved D2 chart generation with more comprehensive internal examples to enhance output quality.
206
-
207
- ## Version 0.8.0 (2025-09-03)
208
-
209
- ### New Features
210
-
211
- - Updated the guidelines for custom components with new formatting restrictions.
212
-
213
- ## Version 0.7.1 (2025-08-31)
214
-
215
- ### Bug Fixes
216
-
217
- - Fixed a bug where using the Tab key for path selection did not work as expected.
218
-
219
- ## Version 0.7.0 (2025-08-30)
220
-
221
- ### New Features
222
-
223
- - Added an interactive chat mode for generating and managing documentation.
224
- - Introduced support for D2 charts in the document generation and publishing workflow.
225
- - Enabled support for custom components and more robust configuration handling.
226
-
227
- ## Version 0.6.0 (2025-08-27)
228
-
229
- ### New Features
230
-
231
- - Implemented support for media processing before publishing documents.
232
-
233
- ## Version 0.5.0 (2025-08-26)
234
-
235
- ### New Features
236
-
237
- - User feedback can now be saved as persistent preferences for future sessions.
238
-
239
- ### Bug Fixes
240
-
241
- - Polished the text of questions asked during the initial setup process.
242
-
243
- ## Version 0.4.4 (2025-08-22)
244
-
245
- ### Bug Fixes
246
-
247
- - Added support for assigning a board ID during the publishing process.
248
-
249
- ## Version 0.4.1 (2025-08-21)
250
-
251
- ### Bug Fixes
252
-
253
- - Added support for updating board information.
254
-
255
- ## Version 0.4.0 (2025-08-20)
256
-
257
- ### New Features
258
-
259
- - Introduced a new `translate` command for translating documents.
260
-
261
- ## Version 0.3.0 (2025-08-19)
262
-
263
- ### New Features
264
-
265
- - Refined the workflow for collecting context during document generation.
266
-
267
- ### Bug Fixes
268
-
269
- - Optimized the help text for users running a self-hosted Discuss Kit instance.
270
-
271
- ## Version 0.2.11 (2025-08-15)
272
-
273
- ### Bug Fixes
274
-
275
- - Switched the default large language model to improve generation quality.
276
-
277
- ## Version 0.2.5 (2025-08-08)
278
-
279
- ### Bug Fixes
280
-
281
- - Polished the command-line interface process for a smoother user experience.
282
-
283
- ## Version 0.2.0 (2025-08-05)
284
-
285
- ### New Features
286
-
287
- - The tool will now automatically initialize the configuration if it is missing when a command is run.
288
- - Added a new `update` command to refresh documents when source files have changed.
@@ -1,255 +0,0 @@
1
- # 發行說明
2
-
3
- 本文件概述了此工具每個版本的新功能、改進和錯誤修復。所有變更均按時間倒序列出。
4
-
5
- ## 版本 0.8.12-beta.3 (2025-10-09)
6
-
7
- ### 錯誤修復
8
-
9
- - 解決了發布至雲端時錯誤地要求管理員權限的問題。
10
-
11
- ## 版本 0.8.12-beta.2 (2025-10-09)
12
-
13
- ### 錯誤修復
14
-
15
- - 修正了更新文件時檔案路徑的錯誤。
16
- - 修復了可能導致文件生成與更新失敗的問題。
17
-
18
- ## 版本 0.8.12-beta.1 (2025-10-08)
19
-
20
- ### 新功能
21
-
22
- - 引入了歷史追蹤功能,讓您能查看文件的過往變更。
23
- - 翻譯現在是文件更新過程中的一個可選步驟,提供了更大的靈活性。
24
-
25
- ### 改進
26
-
27
- - 優化了文件生成與更新流程,以提高可靠性。
28
-
29
- ## 版本 0.8.12-beta (2025-10-07)
30
-
31
- ### 錯誤修復
32
-
33
- - 內部檔案讀取工具現在能正確支援相對路徑。
34
-
35
- ## 版本 0.8.11 (2025-10-05)
36
-
37
- 此版本包含一般維護和穩定性改進。
38
-
39
- ## 版本 0.8.11-beta.7 (2025-10-03)
40
-
41
- ### 新功能
42
-
43
- - 增強了文件生成器與更新器,以提升效能。
44
- - 透過使用共用上下文,提升了文件結構分析和內容優化的速度。
45
-
46
- ### 錯誤修復
47
-
48
- - 更新了內部文件並優化了自訂元件的提示,以提高準確性。
49
-
50
- ## 版本 0.8.11-beta.5 (2025-10-01)
51
-
52
- ### 新功能
53
-
54
- - 新增支援發布時的使用者角色需求及自訂規則配置。
55
- - 將 D2 圖表生成功能分離為獨立工具,以提供更專注的功能。
56
-
57
- ## 版本 0.8.11-beta.4 (2025-09-30)
58
-
59
- ### 新功能
60
-
61
- - 為使用選擇輸入的 Agent 新增了「僅檢查」選項。
62
-
63
- ### 錯誤修復
64
-
65
- - 改善了文件選擇工具中的錯誤處理。
66
- - 調整了翻譯提示;現在程式碼區塊內的註解可以被正確翻譯。
67
-
68
- ## 版本 0.8.11-beta.3 (2025-09-29)
69
-
70
- ### 錯誤修復
71
-
72
- - 為評估 Agent 新增了命令列入口。
73
-
74
- ## 版本 0.8.11-beta.2 (2025-09-27)
75
-
76
- ### 錯誤修復
77
-
78
- - 解決了依賴性衝突,以確保運作更順暢。
79
-
80
- ## 版本 0.8.11-beta.1 (2025-09-27)
81
-
82
- ### 新功能
83
-
84
- - 引入了文件評估功能,以生成品質報告。
85
- - 透過改進的工具增強了文件與結構的更新流程。
86
- - 改善了發布過程中的供應商處理與除錯能力。
87
-
88
- ### 錯誤修復
89
-
90
- - 修復了元件描述被視為屬性而非文字的問題,改善了自訂元件的渲染效果。
91
-
92
- ## 版本 0.8.10 (2025-09-20)
93
-
94
- 此版本包含一般維護和穩定性改進。
95
-
96
- ## 版本 0.8.10-beta.3 (2025-09-19)
97
-
98
- ### 錯誤修復
99
-
100
- - 新增了與企業部署相關的連結。
101
- - 優化了文件審查提示的文案。
102
-
103
- ## 版本 0.8.10-beta.2 (2025-09-18)
104
-
105
- ### 錯誤修復
106
-
107
- - 改善了文件結構審查的提示與顯示方式。
108
- - 更新了欄位元素的使用規則,以確保正確渲染。
109
-
110
- ## 版本 0.8.10-beta.1 (2025-09-18)
111
-
112
- ### 新功能
113
-
114
- - 新增了在生成文件前審查其結構的工作流程。
115
-
116
- ### 錯誤修復
117
-
118
- - 提升了使用者介面中英文文本的一致性與清晰度。
119
- - 更新了 DocSmith 的標誌。
120
-
121
- ## 版本 0.8.9 (2025-09-15)
122
-
123
- ### 錯誤修復
124
-
125
- - 更新了 D2 圖表的主題顏色,以達到更好的視覺一致性。
126
-
127
- ## 版本 0.8.8 (2025-09-13)
128
-
129
- ### 錯誤修復
130
-
131
- - 優化了查詢回饋的文案,使其更清晰、更有幫助。
132
-
133
- ## 版本 0.8.7 (2025-09-12)
134
-
135
- ### 新功能
136
-
137
- - 新增支援使用 `<x-field>` 自訂元件來定義 API 參數。
138
-
139
- ## 版本 0.8.6 (2025-09-11)
140
-
141
- ### 新功能
142
-
143
- - 成功發布後,現在會預設顯示 URL。
144
-
145
- ### 錯誤修復
146
-
147
- - 確保在部署過程中能正確儲存日誌,以防止資料遺失。
148
-
149
- ## 版本 0.8.5 (2025-09-10)
150
-
151
- ### 新功能
152
-
153
- - 新增支援將文件發布至企業空間。
154
-
155
- ## 版本 0.8.4 (2025-09-09)
156
-
157
- ### 錯誤修復
158
-
159
- - Markdown 程式碼區塊現在會被解析為自訂的 `<x-code>` 元素,並支援標題和圖示等增強屬性。
160
- - 將 D2 圖表的背景設為透明,以便更好地與不同主題整合。
161
-
162
- ## 版本 0.8.3 (2025-09-05)
163
-
164
- ### 錯誤修復
165
-
166
- - 為本地圖片新增了自動尺寸偵測功能,以確保其顯示正確。
167
-
168
- ## 版本 0.8.1 (2025-09-03)
169
-
170
- ### 新功能
171
-
172
- - 透過更全面的範例調整了 D2 圖表生成,以提高輸出品質。
173
-
174
- ## 版本 0.8.0 (2025-09-03)
175
-
176
- ### 新功能
177
-
178
- - 更新了自訂元件的指南,並新增了格式限制。
179
-
180
- ## 版本 0.7.1 (2025-08-31)
181
-
182
- ### 錯誤修復
183
-
184
- - 修復了使用 Tab 鍵進行路徑選擇時未如預期運作的錯誤。
185
-
186
- ## 版本 0.7.0 (2025-08-30)
187
-
188
- ### 新功能
189
-
190
- - 新增了用於生成和管理文件的互動式聊天模式。
191
- - 在文件生成與發布工作流程中引入了對 D2 圖表的支援。
192
- - 啟用對自訂元件的支援,並提供更穩健的配置處理。
193
-
194
- ## 版本 0.6.0 (2025-08-27)
195
-
196
- ### 新功能
197
-
198
- - 實現了在發布文件前對媒體處理的完整支援。
199
-
200
- ## 版本 0.5.0 (2025-08-26)
201
-
202
- ### 新功能
203
-
204
- - 使用者回饋現在可以儲存為持久性偏好設定,供未來會話使用。
205
-
206
- ### 錯誤修復
207
-
208
- - 優化了初始設定過程中提問的文字。
209
-
210
- ## 版本 0.4.4 (2025-08-22)
211
-
212
- ### 錯誤修復
213
-
214
- - 新增在發布過程中指派看板 ID 的支援。
215
-
216
- ## 版本 0.4.1 (2025-08-21)
217
-
218
- ### 錯誤修復
219
-
220
- - 新增更新看板資訊的支援。
221
-
222
- ## 版本 0.4.0 (2025-08-20)
223
-
224
- ### 新功能
225
-
226
- - 引入了用於翻譯文件的 `translate` 新命令。
227
-
228
- ## 版本 0.3.0 (2025-08-19)
229
-
230
- ### 新功能
231
-
232
- - 優化了在文件生成期間收集上下文的工作流程。
233
-
234
- ### 錯誤修復
235
-
236
- - 為執行自行託管 Discuss Kit 實例的使用者優化了說明文字。
237
-
238
- ## 版本 0.2.11 (2025-08-15)
239
-
240
- ### 錯誤修復
241
-
242
- - 更換了預設語言模型以提高生成品質。
243
-
244
- ## 版本 0.2.5 (2025-08-08)
245
-
246
- ### 錯誤修復
247
-
248
- - 優化了命令列介面流程,以提供更流暢的使用者體驗。
249
-
250
- ## 版本 0.2.0 (2025-08-05)
251
-
252
- ### 新功能
253
-
254
- - 當執行命令時若缺少設定檔,工具現在將自動進行初始化。
255
- - 新增了 `update` 命令,以便在來源檔案變更時更新文件。