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

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 (91) hide show
  1. package/.aigne/doc-smith/config.yaml +1 -1
  2. package/.aigne/doc-smith/history.yaml +37 -0
  3. package/.aigne/doc-smith/media-description.yaml +91 -0
  4. package/.aigne/doc-smith/preferences.yml +12 -0
  5. package/.aigne/doc-smith/upload-cache.yaml +36 -69
  6. package/.release-please-manifest.json +1 -1
  7. package/CHANGELOG.md +24 -0
  8. package/agents/clear/choose-contents.mjs +14 -1
  9. package/agents/clear/clear-media-description.mjs +129 -0
  10. package/agents/clear/index.yaml +3 -1
  11. package/agents/evaluate/code-snippet.mjs +28 -24
  12. package/agents/evaluate/document-structure.yaml +0 -4
  13. package/agents/evaluate/document.yaml +1 -5
  14. package/agents/generate/index.yaml +1 -0
  15. package/agents/generate/update-document-structure.yaml +9 -3
  16. package/agents/history/view.mjs +5 -2
  17. package/agents/init/index.mjs +10 -0
  18. package/agents/media/batch-generate-media-description.yaml +44 -0
  19. package/agents/media/generate-media-description.yaml +47 -0
  20. package/agents/media/load-media-description.mjs +238 -0
  21. package/agents/update/generate-document.yaml +10 -4
  22. package/agents/update/index.yaml +1 -0
  23. package/agents/update/update-document-detail.yaml +9 -3
  24. package/agents/update/user-review-document.mjs +2 -1
  25. package/agents/utils/load-sources.mjs +103 -53
  26. package/aigne.yaml +6 -0
  27. package/assets/report-template/report.html +34 -34
  28. package/docs/configuration-initial-setup.md +74 -55
  29. package/docs/configuration.ja.md +59 -86
  30. package/docs/configuration.md +59 -86
  31. package/docs/configuration.zh-TW.md +59 -86
  32. package/docs/configuration.zh.md +59 -86
  33. package/docs/getting-started.ja.md +43 -24
  34. package/docs/getting-started.md +29 -10
  35. package/docs/getting-started.zh-TW.md +42 -23
  36. package/docs/getting-started.zh.md +39 -20
  37. package/docs/guides-cleaning-up.ja.md +16 -15
  38. package/docs/guides-cleaning-up.md +19 -17
  39. package/docs/guides-cleaning-up.zh-TW.md +16 -15
  40. package/docs/guides-cleaning-up.zh.md +12 -11
  41. package/docs/guides-evaluating-documents.md +70 -29
  42. package/docs/guides-generating-documentation.ja.md +34 -32
  43. package/docs/guides-generating-documentation.md +59 -119
  44. package/docs/guides-generating-documentation.zh-TW.md +34 -32
  45. package/docs/guides-generating-documentation.zh.md +30 -28
  46. package/docs/guides-interactive-chat.md +34 -26
  47. package/docs/guides-managing-history.ja.md +17 -20
  48. package/docs/guides-managing-history.md +19 -17
  49. package/docs/guides-managing-history.zh-TW.md +18 -21
  50. package/docs/guides-managing-history.zh.md +13 -16
  51. package/docs/guides-publishing-your-docs.md +40 -35
  52. package/docs/guides-translating-documentation.ja.md +17 -17
  53. package/docs/guides-translating-documentation.md +39 -34
  54. package/docs/guides-translating-documentation.zh-TW.md +21 -21
  55. package/docs/guides-translating-documentation.zh.md +18 -18
  56. package/docs/guides-updating-documentation.ja.md +35 -35
  57. package/docs/guides-updating-documentation.md +11 -9
  58. package/docs/guides-updating-documentation.zh-TW.md +27 -27
  59. package/docs/guides-updating-documentation.zh.md +26 -26
  60. package/docs/overview.ja.md +13 -13
  61. package/docs/overview.md +2 -2
  62. package/docs/overview.zh-TW.md +19 -19
  63. package/docs/overview.zh.md +16 -16
  64. package/docs/release-notes.md +60 -27
  65. package/package.json +2 -1
  66. package/prompts/common/afs/afs-tools-usage.md +5 -0
  67. package/prompts/common/afs/use-afs-instruction.md +1 -0
  68. package/prompts/detail/generate/system-prompt.md +0 -13
  69. package/prompts/detail/generate/user-prompt.md +7 -0
  70. package/prompts/detail/update/system-prompt.md +1 -2
  71. package/prompts/detail/update/user-prompt.md +7 -0
  72. package/prompts/evaluate/document-structure.md +6 -7
  73. package/prompts/evaluate/document.md +16 -25
  74. package/prompts/media/media-description/system-prompt.md +35 -0
  75. package/prompts/media/media-description/user-prompt.md +8 -0
  76. package/prompts/structure/generate/system-prompt.md +0 -19
  77. package/prompts/structure/generate/user-prompt.md +22 -1
  78. package/prompts/structure/update/system-prompt.md +0 -17
  79. package/prompts/structure/update/user-prompt.md +24 -0
  80. package/tests/agents/history/view.test.mjs +97 -0
  81. package/tests/utils/history-utils.test.mjs +125 -97
  82. package/utils/constants/index.mjs +0 -107
  83. package/utils/file-utils.mjs +42 -1
  84. package/utils/history-utils.mjs +3 -3
  85. package/agents/update/fs-tools/glob.mjs +0 -184
  86. package/agents/update/fs-tools/grep.mjs +0 -317
  87. package/agents/update/fs-tools/read-file.mjs +0 -309
  88. package/media.md +0 -19
  89. package/tests/agents/update/fs-tools/glob.test.mjs +0 -438
  90. package/tests/agents/update/fs-tools/grep.test.mjs +0 -279
  91. package/tests/agents/update/fs-tools/read-file.test.mjs +0 -549
@@ -67,8 +67,8 @@ sourcesPath: # Source code paths to analyze
67
67
  - ./CHANGELOG.md
68
68
  - ./aigne.yaml
69
69
  - ./agents
70
- - ./media.md
71
70
  - ./.aigne/doc-smith/config.yaml
71
+ - ./assets/screenshots
72
72
  lastGitHead: f0db74dffd0876dab4cc3ad628523abd359c9430
73
73
  # ⚠️ Warning: boardId is auto-generated by system, please do not edit manually
74
74
  boardId: "docsmith"
@@ -0,0 +1,37 @@
1
+ entries:
2
+ - timestamp: 2025-10-11T13:21:51.992Z
3
+ operation: translation_update
4
+ feedback: Do not translate the Target column in the Cleanup Targets table.
5
+ documentPath: /guides/cleaning-up
6
+ - timestamp: 2025-10-11T13:20:30.314Z
7
+ operation: document_update
8
+ feedback: The targets in Cleanup Targets are incomplete and need to be supplemented. The corresponding descriptions also require updating. Additionally, the target values should use the original enumeration values, such as 'generatedDocs'.
9
+ documentPath: /guides/cleaning-up
10
+ - timestamp: 2025-10-11T13:03:20.327Z
11
+ operation: document_update
12
+ feedback: The two aliases for the 'history' command in Viewing Update History can be combined into a single code block. The Short Hash in Understanding the History Output now consists of 8 characters. Additionally, operation types are separated by underscores, such as 'document_update'.
13
+ documentPath: /guides/managing-history
14
+ - timestamp: 2025-10-11T12:56:23.107Z
15
+ operation: document_update
16
+ feedback: In interactive mode, translated files are saved with a suffix appended to their original filenames within the same directory, rather than in dedicated language directories.
17
+ documentPath: /guides/translating-documentation
18
+ - timestamp: 2025-10-11T12:50:25.563Z
19
+ operation: document_update
20
+ feedback: The value of the 'docs' parameter in the demo should be a path separated by '-' rather than '/', and '.md' should be preserved.
21
+ documentPath: /guides/updating-documentation
22
+ - timestamp: 2025-10-11T12:46:37.507Z
23
+ operation: document_update
24
+ feedback: The value of the 'docs' parameter in the demo should be a path separated by '-' rather than '/'.
25
+ documentPath: /guides/updating-documentation
26
+ - timestamp: 2025-10-11T12:39:53.222Z
27
+ operation: document_update
28
+ feedback: The prompts in Review the Documentation Structure are outdated and need updating. Command Parameters also require updating.
29
+ documentPath: /guides/generating-documentation
30
+ - timestamp: 2025-10-11T12:26:24.598Z
31
+ operation: translation_update
32
+ feedback: AIGNE Framework is a proper noun and has its own link; no translation is required.
33
+ documentPath: /overview
34
+ - timestamp: 2025-10-11T12:24:05.477Z
35
+ operation: document_update
36
+ feedback: Add a link to the AIGNE Framework 'https://www.aigne.io/framework'.
37
+ documentPath: /overview
@@ -0,0 +1,91 @@
1
+ descriptions:
2
+ 5838723847ec201191b002ef7d44937d92386a82755ca7a66374acff6b91325e:
3
+ path: ../assets/screenshots/doc-translate.png
4
+ description: This screenshot illustrates a user interface for document
5
+ translation. It displays options for selecting the source and target
6
+ languages, along with an area for document input or upload. The image
7
+ demonstrates the initial steps for translating a document within a
8
+ software application or web service.
9
+ generatedAt: 2025-10-13T10:16:56.300Z
10
+ ac51399fcd5ba2e36d7c84264dd28624acd10c57aa82f7d006da6f8434cb24de:
11
+ path: ../assets/screenshots/doc-regenerate.png
12
+ description: This screenshot displays a user interface element for a
13
+ 'Regenerate' function, likely within an application or content management
14
+ system. It visually demonstrates how users can trigger the re-rendering or
15
+ updating of content, often showing a button or control and potentially the
16
+ immediate output or status of the regeneration process.
17
+ generatedAt: 2025-10-13T10:16:56.301Z
18
+ 9871bff567cc5f1b73e99b84c03781bffc7f531635b9bd40f23a2aee5f9885e5:
19
+ path: ../assets/screenshots/doc-update.png
20
+ description: This image is a screenshot depicting a user interface for updating
21
+ documentation content. It showcases a main text editing area, likely with
22
+ rich text formatting capabilities, accompanied by buttons for actions such
23
+ as saving, previewing, or publishing changes. The layout suggests a
24
+ content management system or a wiki-style editing environment.
25
+ generatedAt: 2025-10-13T10:16:56.301Z
26
+ 31353781ba6d1572359823faa399af9f5deca7b994f24939cb5f5143fcc96b14:
27
+ path: ../assets/screenshots/doc-translate-langs.png
28
+ description: This screenshot depicts a user interface element focused on
29
+ language selection for documentation translation. It displays a list or
30
+ menu of languages, allowing users to choose or configure the target
31
+ languages for translating documentation content. The image highlights the
32
+ functionality for managing multilingual documentation.
33
+ generatedAt: 2025-10-13T10:16:56.301Z
34
+ a42903e87ae020dcb81991e672b2a2990b94eb0e92d6c1cc87f3bf6223355344:
35
+ path: ../assets/screenshots/doc-publish.png
36
+ description: This is a screenshot of a "Publish Documentation" dialog box from a
37
+ user interface. It presents options for selecting documentation to publish
38
+ and configuring various publication settings, including checkboxes for
39
+ search indexing and versioning. The dialog features "Cancel" and "Publish"
40
+ action buttons at the bottom right.
41
+ generatedAt: 2025-10-13T10:16:56.301Z
42
+ c055a80de6c1120765757fd3ef91ef05718f77beb7d6dfdac41d8e234361a68a:
43
+ path: ../assets/screenshots/doc-generated-successfully.png
44
+ description: This is a screenshot of a success notification banner,
45
+ characterized by its wide and short dimensions. It displays a positive
46
+ message such as "Document generated successfully," likely accompanied by a
47
+ green checkmark or other visual cues indicating a successful operation.
48
+ This image is suitable for illustrating UI feedback when a document
49
+ generation process is completed.
50
+ generatedAt: 2025-10-13T10:16:56.301Z
51
+ f786c36289e0e5bfea866c9384edc7d44996c42adfad0cb6f613f46e27f0f2be:
52
+ path: ../assets/screenshots/doc-generate.png
53
+ description: This screenshot displays a "Generate Documentation" dialog,
54
+ presenting various options for outputting documentation files. Users can
55
+ specify an output path, choose to include example content, overwrite
56
+ existing files, and generate the documentation in dark mode, before
57
+ confirming with "Generate" or "Cancel."
58
+ generatedAt: 2025-10-13T10:16:56.301Z
59
+ 2b41c70c6a61942727984b2d99010cbe7e1d9b4c75686f65af8b5a245e9b800d:
60
+ path: ../assets/screenshots/doc-generate-docs.png
61
+ description: This image is a screenshot illustrating a user interface for a
62
+ documentation generation process. It depicts a dialog or panel with
63
+ various configuration options and controls, likely including output format
64
+ selections and a prominent "Generate" button to initiate the creation of
65
+ documentation.
66
+ generatedAt: 2025-10-13T10:16:56.301Z
67
+ 44cb2fc222a3dd15fa82f1088d9113b0bb1bfc8b29a0e568a2273d80e8f50a7d:
68
+ path: ../assets/screenshots/doc-complete-setup.png
69
+ description: This screenshot depicts the "Setup Complete" screen from a user
70
+ interface, indicating the successful conclusion of an installation or
71
+ configuration process. It features a prominent confirmation message, such
72
+ as "Setup Complete!", often accompanied by a success icon and an
73
+ actionable button like "Continue" or "Go to Dashboard" to proceed.
74
+ generatedAt: 2025-10-13T10:16:56.301Z
75
+ 13a9073d16762909e189af4e53ceb004abe1c55681d12726fceb262205fbf180:
76
+ path: ../assets/screenshots/doc-generate.png
77
+ description: This screenshot displays a user interface for generating
78
+ documentation. It features various input fields and controls, likely for
79
+ configuring options such as output format, target location, and content
80
+ selection. The image serves to illustrate the steps or settings involved
81
+ in the documentation generation process.
82
+ generatedAt: 2025-10-13T14:07:35.096Z
83
+ 90c0daa8347df01c8154b6a5b30879b691c4a94b49c970b0480435591603bf55:
84
+ path: ../assets/screenshots/doc-complete-setup.png
85
+ description: This image is a screenshot displaying a "Setup Complete" success
86
+ message within a user interface. It shows a clear green checkmark icon, a
87
+ bold headline confirming the setup is finished, and additional descriptive
88
+ text below. A prominent "Done" button is visible at the bottom of the
89
+ interface, indicating the next action for the user.
90
+ generatedAt: 2025-10-13T14:07:35.097Z
91
+ lastUpdated: 2025-10-13T14:07:35.098Z
@@ -1,4 +1,16 @@
1
1
  rules:
2
+ - id: pref_cbc8005011c08ca0
3
+ active: true
4
+ scope: translation
5
+ rule: In the table titled 'Cleanup Targets', the 'Target' column must retain the original text and should not be translated.
6
+ feedback: Do not translate the Target column in the Cleanup Targets table.
7
+ createdAt: 2025-10-11T13:22:06.529Z
8
+ - id: pref_545cabc521ecd4a5
9
+ active: true
10
+ scope: translation
11
+ rule: The proprietary term 'AIGNE Framework' must not be translated and must be retained in its original form.
12
+ feedback: AIGNE Framework is a proper noun and has its own link; no translation is required.
13
+ createdAt: 2025-10-11T12:26:37.517Z
2
14
  - id: pref_6e612d7ca8b7f3b6
3
15
  active: true
4
16
  scope: document
@@ -4,18 +4,12 @@ f1faeee67ce652ecbabb1dfd8f58bed4dd5edbb89b929bc84763c278a140df94:
4
4
  https://docsmith.aigne.io:
5
5
  url: https://docsmith.aigne.io/image-bin/uploads/f1faeee67ce652ec.svg
6
6
  upload_time: 2025-09-07T02:41:04.292Z
7
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
8
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/f1faeee67ce652ec.svg
9
- upload_time: 2025-09-08T03:55:58.504Z
10
7
  eae90551d172b74a8a52e95590da49dafda4a3301a7b367d48cb23b4afcbc45c:
11
8
  local_path: .aigne/doc-smith/.tmp/assets/d2/fb4c5fd8c2eb3dcc875bbcaf1b88723c1e5c9554d9f31d3b468edce69189c594.svg
12
9
  sites:
13
10
  https://docsmith.aigne.io:
14
11
  url: https://docsmith.aigne.io/image-bin/uploads/eae90551d172b74a.svg
15
12
  upload_time: 2025-09-07T02:41:04.799Z
16
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
17
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/eae90551d172b74a.svg
18
- upload_time: 2025-09-08T03:55:59.449Z
19
13
  https://staging.docsmith.aigne.io:
20
14
  url: https://staging.docsmith.aigne.io/image-bin/uploads/eae90551d172b74a.svg
21
15
  upload_time: 2025-09-08T11:10:19.607Z
@@ -25,9 +19,6 @@ eae90551d172b74a8a52e95590da49dafda4a3301a7b367d48cb23b4afcbc45c:
25
19
  https://docsmith.aigne.io:
26
20
  url: https://docsmith.aigne.io/image-bin/uploads/6deb3db3a9e53857.svg
27
21
  upload_time: 2025-09-07T02:41:06.038Z
28
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
29
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/6deb3db3a9e53857.svg
30
- upload_time: 2025-09-08T03:56:00.513Z
31
22
  https://staging.docsmith.aigne.io:
32
23
  url: https://staging.docsmith.aigne.io/image-bin/uploads/6deb3db3a9e53857.svg
33
24
  upload_time: 2025-09-08T11:10:20.788Z
@@ -37,63 +28,42 @@ eae90551d172b74a8a52e95590da49dafda4a3301a7b367d48cb23b4afcbc45c:
37
28
  https://docsmith.aigne.io:
38
29
  url: https://docsmith.aigne.io/image-bin/uploads/72c701cdaedfcaa8.svg
39
30
  upload_time: 2025-09-07T02:41:06.112Z
40
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
41
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/72c701cdaedfcaa8.svg
42
- upload_time: 2025-09-08T03:55:59.067Z
43
31
  3f5fa2cedee9fd6129f8d7e9312eaa2018c11842c3f36156a641d8c24571d813:
44
32
  local_path: .aigne/doc-smith/.tmp/assets/d2/6cbfe7ab77c5caee47b7e77eb66f71573ac8befaf561080dda4c929b850b10e2.svg
45
33
  sites:
46
34
  https://docsmith.aigne.io:
47
35
  url: https://docsmith.aigne.io/image-bin/uploads/3f5fa2cedee9fd61.svg
48
36
  upload_time: 2025-09-07T02:41:06.225Z
49
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
50
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/3f5fa2cedee9fd61.svg
51
- upload_time: 2025-09-08T03:56:00.535Z
52
37
  8738c2d2ccb63652b5a815e90096defb9d3bacf37a3c29e8350d5ad0f56d6141:
53
38
  local_path: .aigne/doc-smith/.tmp/assets/d2/b00ba2c7147bb27e092e2c2b2d9634131c73d751c3971b6380375a81efec4450.svg
54
39
  sites:
55
40
  https://docsmith.aigne.io:
56
41
  url: https://docsmith.aigne.io/image-bin/uploads/8738c2d2ccb63652.svg
57
42
  upload_time: 2025-09-07T02:41:07.628Z
58
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
59
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/8738c2d2ccb63652.svg
60
- upload_time: 2025-09-08T03:56:01.100Z
61
43
  6dd581bc815d3b87b3a5b7e0706b7e46670d0609cddaf7f6276d22ba923198f6:
62
44
  local_path: .aigne/doc-smith/.tmp/assets/d2/dad5224fdc7ba3ab76738a333a0f443dc6a51e4ed10e0242f44e17a9c93266c6.svg
63
45
  sites:
64
46
  https://docsmith.aigne.io:
65
47
  url: https://docsmith.aigne.io/image-bin/uploads/6dd581bc815d3b87.svg
66
48
  upload_time: 2025-09-07T02:41:07.704Z
67
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
68
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/6dd581bc815d3b87.svg
69
- upload_time: 2025-09-08T03:55:59.692Z
70
49
  dcae1350b6f914c7b62b61fd0b303e704bffe6cdfb5575473f2251cab5290750:
71
50
  local_path: .aigne/doc-smith/.tmp/assets/d2/d5a31b70ed89f445a4fe500e9290620304c21536b05db7e0a205000778ff60d3.svg
72
51
  sites:
73
52
  https://docsmith.aigne.io:
74
53
  url: https://docsmith.aigne.io/image-bin/uploads/dcae1350b6f914c7.svg
75
54
  upload_time: 2025-09-07T02:41:07.709Z
76
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
77
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/dcae1350b6f914c7.svg
78
- upload_time: 2025-09-08T03:55:59.696Z
79
55
  4fca09589d9bfa0b43629cc773f07e1826b0b32f60693f58d5df315b0c17bda3:
80
56
  local_path: .aigne/doc-smith/.tmp/assets/d2/c476e5911e80af0317a8bdb81e58b2e860044ea1a8df6ebd5a9fe17af95aee1d.svg
81
57
  sites:
82
58
  https://docsmith.aigne.io:
83
59
  url: https://docsmith.aigne.io/image-bin/uploads/4fca09589d9bfa0b.svg
84
60
  upload_time: 2025-09-07T02:41:07.918Z
85
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
86
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/4fca09589d9bfa0b.svg
87
- upload_time: 2025-09-08T03:56:00.157Z
88
61
  c6babdcdfee3317a8bacef57d538f549460057ed789d16996365a9bf17365111:
89
62
  local_path: .aigne/doc-smith/.tmp/assets/d2/c1cf0d4d14083306579111cd0309f28df04f16f44749a8528d901de3effba32f.svg
90
63
  sites:
91
64
  https://docsmith.aigne.io:
92
65
  url: https://docsmith.aigne.io/image-bin/uploads/c6babdcdfee3317a.svg
93
66
  upload_time: 2025-09-07T02:41:07.948Z
94
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
95
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/c6babdcdfee3317a.svg
96
- upload_time: 2025-09-08T03:55:59.660Z
97
67
  https://staging.docsmith.aigne.io:
98
68
  url: https://staging.docsmith.aigne.io/image-bin/uploads/c6babdcdfee3317a.svg
99
69
  upload_time: 2025-09-08T11:10:28.287Z
@@ -103,18 +73,12 @@ d69b740fc5768eea571fb53bae9c074a4e405b317a74f6b5539c4c9a90eacbdc:
103
73
  https://docsmith.aigne.io:
104
74
  url: https://docsmith.aigne.io/image-bin/uploads/d69b740fc5768eea.svg
105
75
  upload_time: 2025-09-07T02:41:07.983Z
106
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
107
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/d69b740fc5768eea.svg
108
- upload_time: 2025-09-08T03:56:01.112Z
109
76
  93e8843c9ce8b8bcebb364026ea4170edb6dde0860c87913ddc821fcd74e6686:
110
77
  local_path: .aigne/doc-smith/.tmp/assets/d2/1818a01695c2396616a74572e4c85d712fab1c714ae52c2cb1084e751168173d.svg
111
78
  sites:
112
79
  https://docsmith.aigne.io:
113
80
  url: https://docsmith.aigne.io/image-bin/uploads/93e8843c9ce8b8bc.svg
114
81
  upload_time: 2025-09-07T02:41:09.091Z
115
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
116
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/93e8843c9ce8b8bc.svg
117
- upload_time: 2025-09-08T03:55:59.694Z
118
82
  https://staging.docsmith.aigne.io:
119
83
  url: https://staging.docsmith.aigne.io/image-bin/uploads/93e8843c9ce8b8bc.svg
120
84
  upload_time: 2025-09-08T11:10:30.044Z
@@ -124,72 +88,48 @@ d69b740fc5768eea571fb53bae9c074a4e405b317a74f6b5539c4c9a90eacbdc:
124
88
  https://docsmith.aigne.io:
125
89
  url: https://docsmith.aigne.io/image-bin/uploads/7820ba0126b7ffe9.svg
126
90
  upload_time: 2025-09-07T02:41:09.288Z
127
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
128
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/7820ba0126b7ffe9.svg
129
- upload_time: 2025-09-08T03:56:00.334Z
130
91
  b51eefd7ac6ba3c1536f66ee064b251aaae80569cc641c4fef7197596ded9f09:
131
92
  local_path: .aigne/doc-smith/.tmp/assets/d2/be4a5ff64f7a27cc04b17bbc4e65d5e2105b2cb02c24b40597ae12d5bb3a5bc1.svg
132
93
  sites:
133
94
  https://docsmith.aigne.io:
134
95
  url: https://docsmith.aigne.io/image-bin/uploads/b51eefd7ac6ba3c1.svg
135
96
  upload_time: 2025-09-07T02:41:09.389Z
136
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
137
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/b51eefd7ac6ba3c1.svg
138
- upload_time: 2025-09-08T03:56:00.306Z
139
97
  8045a0dc2db88042666b71947f84f999979df3d22ebc1ce36c6d982baea512e8:
140
98
  local_path: .aigne/doc-smith/.tmp/assets/d2/09537edb3659c17ca6f1ddbc30b85bd423571119a6fd5c4befcc5d48ca5d6aea.svg
141
99
  sites:
142
100
  https://docsmith.aigne.io:
143
101
  url: https://docsmith.aigne.io/image-bin/uploads/8045a0dc2db88042.svg
144
102
  upload_time: 2025-09-07T02:41:09.409Z
145
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
146
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/8045a0dc2db88042.svg
147
- upload_time: 2025-09-08T03:56:00.343Z
148
103
  d009775dff4f0355d16098d276d84e20d84ed9b64429c3ca2ac0bc82de4ebabb:
149
104
  local_path: .aigne/doc-smith/.tmp/assets/d2/d04fb2e90c0d87aedf17736967cdd3c4cd43d9647dc4215d28376beb2ded28c6.svg
150
105
  sites:
151
106
  https://docsmith.aigne.io:
152
107
  url: https://docsmith.aigne.io/image-bin/uploads/d009775dff4f0355.svg
153
108
  upload_time: 2025-09-07T02:41:09.746Z
154
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
155
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/d009775dff4f0355.svg
156
- upload_time: 2025-09-08T03:56:00.710Z
157
109
  a69a16add73521702d150a6b437503e52e38ad468e3c77f2e56ed1ba3d05b6ab:
158
110
  local_path: .aigne/doc-smith/.tmp/assets/d2/24e09cc77c5902ad7c2db82c9e1343a8e29b6452a5a9de26a9acf07563b1e64a.svg
159
111
  sites:
160
112
  https://docsmith.aigne.io:
161
113
  url: https://docsmith.aigne.io/image-bin/uploads/a69a16add7352170.svg
162
114
  upload_time: 2025-09-07T02:41:10.676Z
163
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
164
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/a69a16add7352170.svg
165
- upload_time: 2025-09-08T03:56:00.345Z
166
115
  c0010149ea258847e16334eb14aeffcba56b9240c2d120535aabbbe5a00fc680:
167
116
  local_path: .aigne/doc-smith/.tmp/assets/d2/478862a2e05b0b6dcfc4388ebd3e1bf15385d25e76ccdc75689a658c063a2416.svg
168
117
  sites:
169
118
  https://docsmith.aigne.io:
170
119
  url: https://docsmith.aigne.io/image-bin/uploads/c0010149ea258847.svg
171
120
  upload_time: 2025-09-07T02:41:11.199Z
172
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
173
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/c0010149ea258847.svg
174
- upload_time: 2025-09-08T03:56:01.260Z
175
121
  232b7ba47e7986c7e208f1ab22360d3c71e38122842d9e9bf97dbe4ce94ffc61:
176
122
  local_path: .aigne/doc-smith/.tmp/assets/d2/c2a0ff290b2fedb9112b2d6ddf437acf505222cff9360688fca8cb73512e5a40.svg
177
123
  sites:
178
124
  https://docsmith.aigne.io:
179
125
  url: https://docsmith.aigne.io/image-bin/uploads/232b7ba47e7986c7.svg
180
126
  upload_time: 2025-09-07T02:41:12.719Z
181
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
182
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/232b7ba47e7986c7.svg
183
- upload_time: 2025-09-08T03:56:01.866Z
184
127
  c30a114f4b9d34e027a318e956d032c88e9c5a78b719b7e4384454e5c5a5cc70:
185
128
  local_path: .aigne/doc-smith/.tmp/assets/d2/a718b6e368f34b2a8b54e3e4048c6c4fdba06a7937f00dca6c8a9402b464c907.svg
186
129
  sites:
187
130
  https://docsmith.aigne.io:
188
131
  url: https://docsmith.aigne.io/image-bin/uploads/c30a114f4b9d34e0.svg
189
132
  upload_time: 2025-09-07T02:41:12.725Z
190
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
191
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/c30a114f4b9d34e0.svg
192
- upload_time: 2025-09-08T03:56:01.863Z
193
133
  https://staging.docsmith.aigne.io:
194
134
  url: https://staging.docsmith.aigne.io/image-bin/uploads/c30a114f4b9d34e0.svg
195
135
  upload_time: 2025-09-08T11:10:31.820Z
@@ -199,18 +139,12 @@ c30a114f4b9d34e027a318e956d032c88e9c5a78b719b7e4384454e5c5a5cc70:
199
139
  https://docsmith.aigne.io:
200
140
  url: https://docsmith.aigne.io/image-bin/uploads/519fc512d2b35a31.svg
201
141
  upload_time: 2025-09-07T02:41:14.202Z
202
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
203
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/519fc512d2b35a31.svg
204
- upload_time: 2025-09-08T03:56:02.458Z
205
142
  fe5562041c64e27213ef41a7eec1ca1d36fea811437af938671adc0b6eb5378f:
206
143
  local_path: .aigne/doc-smith/.tmp/assets/d2/fd473e7982aac4f9ef8cffeeda302fb0283ad6c147be0f2c95bdac43f1e777dc.svg
207
144
  sites:
208
145
  https://docsmith.aigne.io:
209
146
  url: https://docsmith.aigne.io/image-bin/uploads/fe5562041c64e272.svg
210
147
  upload_time: 2025-09-07T02:41:14.211Z
211
- https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io:
212
- url: https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io/image-bin/uploads/fe5562041c64e272.svg
213
- upload_time: 2025-09-08T03:56:02.461Z
214
148
  f140351d07c690160e5c174fb95460508fd430941336682f79459277958459d5:
215
149
  local_path: .aigne/doc-smith/.tmp/assets/d2/ff6bb4f62e57bbdebe120f9230301b951d9cd5b0ea11177b6ab05b456063ccc9.svg
216
150
  sites:
@@ -1444,9 +1378,6 @@ c055a80de6c1120765757fd3ef91ef05718f77beb7d6dfdac41d8e234361a68a:
1444
1378
  https://bbqa6bbb4lvb4oirkwbmqtjtr37unqcpfbc73xrpxoa-192-168-1-38.ip.abtnet.io:
1445
1379
  url: https://bbqa6bbb4lvb4oirkwbmqtjtr37unqcpfbc73xrpxoa.did.abtnet.io/image-bin/uploads/c055a80de6c11207.png
1446
1380
  upload_time: 2025-10-03T12:42:57.172Z
1447
- https://docsmith.aigne.io:
1448
- url: https://docsmith.aigne.io/image-bin/uploads/c055a80de6c11207.png
1449
- upload_time: 2025-10-03T12:46:49.377Z
1450
1381
  37c8b00ba66a78037147959b615de449f2a33ef55948a208b3b840837db9a058:
1451
1382
  local_path: .aigne/doc-smith/.tmp/assets/d2/d633c85283b25e45932b16ef48a95bb2f663bac92cffa0d081809c87d92c97eb.svg
1452
1383
  sites:
@@ -1861,3 +1792,39 @@ e87fcba2227e472141f99b92eb0247965db132079459ce8c83454dde7fc9a6ae:
1861
1792
  https://docsmith.aigne.io:
1862
1793
  url: https://docsmith.aigne.io/image-bin/uploads/3b189fa893cc2120.svg
1863
1794
  upload_time: 2025-10-10T07:40:22.634Z
1795
+ 7b946c226f73c4c222b37ea23b94b3152932e1712f9d99b78f64c0b93e12bdd9:
1796
+ local_path: .aigne/doc-smith/.tmp/assets/d2/97b496a8d3d5b12b9c8d4d0729110db999a2be33359a1cb70b3f858997ba91a3.svg
1797
+ sites:
1798
+ https://docsmith.aigne.io:
1799
+ url: https://docsmith.aigne.io/image-bin/uploads/7b946c226f73c4c2.svg
1800
+ upload_time: 2025-10-11T16:43:05.278Z
1801
+ c2a826d21a6eeb8664b88a864e1d5ae3ff68bd9e7dad3c46742f855898441747:
1802
+ local_path: .aigne/doc-smith/.tmp/assets/d2/44d2c5dc7e7fcf4ada941e8c4e444b19d5870dd02d44046dea585bbd77b03e0d.svg
1803
+ sites:
1804
+ https://docsmith.aigne.io:
1805
+ url: https://docsmith.aigne.io/image-bin/uploads/c2a826d21a6eeb86.svg
1806
+ upload_time: 2025-10-11T16:43:06.895Z
1807
+ 605705e827c243bb5402f14ed3b7750f2e6564214a81880df12b857c41935917:
1808
+ local_path: .aigne/doc-smith/.tmp/assets/d2/8ff7639517a76840aaf851b1345b8dae330d4df6f5788b70d2c41febf86e63ab.svg
1809
+ sites:
1810
+ https://docsmith.aigne.io:
1811
+ url: https://docsmith.aigne.io/image-bin/uploads/605705e827c243bb.svg
1812
+ upload_time: 2025-10-11T16:43:06.968Z
1813
+ 71ec3af141d2bcda728a2f7e7a47ca2e2e76a86f54d648832d11f4193d9975f4:
1814
+ local_path: .aigne/doc-smith/.tmp/assets/d2/db5b4787a2dc7655434d00ecf3eb9a25fbf73f93cda2b3f10d4022fd9c2bd16b.svg
1815
+ sites:
1816
+ https://docsmith.aigne.io:
1817
+ url: https://docsmith.aigne.io/image-bin/uploads/71ec3af141d2bcda.svg
1818
+ upload_time: 2025-10-11T16:43:08.753Z
1819
+ c61907da62788c6ad5b8d89b0fde7f235046b9a6aed309c43be9b0d5b3abb670:
1820
+ local_path: .aigne/doc-smith/.tmp/assets/d2/8f38985e99e81e8edf973a328862e8ec33cc6de1e1382ebbe55c56f64edbd2ad.svg
1821
+ sites:
1822
+ https://docsmith.aigne.io:
1823
+ url: https://docsmith.aigne.io/image-bin/uploads/c61907da62788c6a.svg
1824
+ upload_time: 2025-10-11T16:43:10.182Z
1825
+ 90c0daa8347df01c8154b6a5b30879b691c4a94b49c970b0480435591603bf55:
1826
+ local_path: assets/screenshots/doc-complete-setup.png
1827
+ sites:
1828
+ 2ecca52715c0775e59a7bb42ccd3295b2e9484924e36240b4080aca70d8892fe:
1829
+ local_path: .aigne/doc-smith/.tmp/assets/d2/9617241af383811cf6e0e07497abf2d2ba35ac5a69d2f74d655f2716f0da6d44.svg
1830
+ sites:
@@ -1,3 +1,3 @@
1
1
  {
2
- ".": "0.8.12-beta.6"
2
+ ".": "0.8.12-beta.8"
3
3
  }
package/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.8.12-beta.8](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.7...v0.8.12-beta.8) (2025-10-14)
4
+
5
+
6
+ ### Features
7
+
8
+ * **media:** support filter and describe and use media files with AI ([#185](https://github.com/AIGNE-io/aigne-doc-smith/issues/185)) ([230271d](https://github.com/AIGNE-io/aigne-doc-smith/commit/230271d70ce2e701be8d6c6e3bdc27f5fadc6cf7))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * update evaluate page template ([#182](https://github.com/AIGNE-io/aigne-doc-smith/issues/182)) ([aef2104](https://github.com/AIGNE-io/aigne-doc-smith/commit/aef21049ded2f1ddfe9309dac67d6db1a026d3f6))
14
+
15
+ ## [0.8.12-beta.7](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.6...v0.8.12-beta.7) (2025-10-12)
16
+
17
+
18
+ ### Features
19
+
20
+ * support retrieve context from repo by AFS ([#175](https://github.com/AIGNE-io/aigne-doc-smith/issues/175)) ([352ce75](https://github.com/AIGNE-io/aigne-doc-smith/commit/352ce751ae9b51a71581793ead7952fb49cda7c4))
21
+
22
+
23
+ ### Bug Fixes
24
+
25
+ * disable git based update history within git repo ([#180](https://github.com/AIGNE-io/aigne-doc-smith/issues/180)) ([826b4bd](https://github.com/AIGNE-io/aigne-doc-smith/commit/826b4bdeb5042b2dcd14ce1da975965ad7805347))
26
+
3
27
  ## [0.8.12-beta.6](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.5...v0.8.12-beta.6) (2025-10-11)
4
28
 
5
29
 
@@ -1,5 +1,10 @@
1
1
  import { getDocSmithEnvFilePath } from "../../utils/auth-utils.mjs";
2
- import { getConfigFilePath, getStructurePlanPath, toDisplayPath } from "../../utils/file-utils.mjs";
2
+ import {
3
+ getConfigFilePath,
4
+ getMediaDescriptionCachePath,
5
+ getStructurePlanPath,
6
+ toDisplayPath,
7
+ } from "../../utils/file-utils.mjs";
3
8
 
4
9
  const TARGET_METADATA = {
5
10
  generatedDocs: {
@@ -36,6 +41,14 @@ const TARGET_METADATA = {
36
41
  `Delete appUrl from './${toDisplayPath(getConfigFilePath(workDir))}'.`,
37
42
  agent: "clearDeploymentConfig",
38
43
  },
44
+ mediaDescription: {
45
+ label: "media file descriptions",
46
+ description: () =>
47
+ `Delete AI-generated descriptions in './${toDisplayPath(
48
+ getMediaDescriptionCachePath(),
49
+ )}' (will regenerate on next generation).`,
50
+ agent: "clearMediaDescription",
51
+ },
39
52
  };
40
53
 
41
54
  const TARGET_KEYS = Object.keys(TARGET_METADATA);
@@ -0,0 +1,129 @@
1
+ import { existsSync } from "node:fs";
2
+ import { readFile, writeFile } from "node:fs/promises";
3
+ import path from "node:path";
4
+ import chalk from "chalk";
5
+ import { parse, stringify } from "yaml";
6
+ import { getMediaDescriptionCachePath } from "../../utils/file-utils.mjs";
7
+
8
+ export default async function clearMediaDescription(_input = {}, options = {}) {
9
+ const cacheFilePath = getMediaDescriptionCachePath();
10
+
11
+ // Check if the cache file exists
12
+ if (!existsSync(cacheFilePath)) {
13
+ return {
14
+ message: "No media descriptions found to clear",
15
+ };
16
+ }
17
+
18
+ try {
19
+ // Read existing cache
20
+ const cacheContent = await readFile(cacheFilePath, "utf8");
21
+ const parsedCache = parse(cacheContent);
22
+ const cache = parsedCache?.descriptions || {};
23
+
24
+ // Get all media files from cache
25
+ const mediaHashes = Object.keys(cache);
26
+
27
+ if (mediaHashes.length === 0) {
28
+ return {
29
+ message: "No media descriptions found to clear",
30
+ };
31
+ }
32
+
33
+ // Build choices from cache - extract filename from path
34
+ const choices = mediaHashes.map((hash) => {
35
+ const mediaPath = cache[hash]?.path || "unknown";
36
+ const filename = path.basename(mediaPath);
37
+ const description = cache[hash]?.description || "";
38
+ const truncatedDesc =
39
+ description.length > 80 ? `${description.slice(0, 80)}...` : description;
40
+
41
+ return {
42
+ name: filename,
43
+ description: truncatedDesc,
44
+ value: hash,
45
+ checked: false,
46
+ };
47
+ });
48
+
49
+ // Add an option to clear all media descriptions
50
+ choices.push({
51
+ name: chalk.red("🗑️ Clear ALL media descriptions"),
52
+ value: "__ALL__",
53
+ checked: false,
54
+ });
55
+
56
+ let selectedHashes = [];
57
+
58
+ if (options?.prompts?.checkbox) {
59
+ selectedHashes = await options.prompts.checkbox({
60
+ message: "Select media files to clear descriptions:",
61
+ choices,
62
+ validate: (answer) => (answer.length > 0 ? true : "Please select at least one item."),
63
+ });
64
+ } else {
65
+ // If no prompts available, clear all
66
+ selectedHashes = ["__ALL__"];
67
+ }
68
+
69
+ if (selectedHashes.length === 0) {
70
+ return {
71
+ message: "No media files selected for clearing descriptions",
72
+ };
73
+ }
74
+
75
+ const results = [];
76
+ let clearedCount = 0;
77
+
78
+ if (selectedHashes.includes("__ALL__")) {
79
+ // Clear all media descriptions
80
+ await writeFile(
81
+ cacheFilePath,
82
+ stringify({
83
+ descriptions: {},
84
+ lastUpdated: new Date().toISOString(),
85
+ }),
86
+ );
87
+ results.push(`Cleared descriptions for all media files (${mediaHashes.length} files)`);
88
+ clearedCount = mediaHashes.length;
89
+ } else {
90
+ // Clear descriptions for selected files
91
+ const updatedCache = { ...cache };
92
+
93
+ for (const hash of selectedHashes) {
94
+ if (updatedCache[hash]) {
95
+ const filename = path.basename(updatedCache[hash].path);
96
+ delete updatedCache[hash];
97
+ results.push(`Cleared description for ${chalk.cyan(filename)}`);
98
+ clearedCount++;
99
+ }
100
+ }
101
+
102
+ await writeFile(
103
+ cacheFilePath,
104
+ stringify({
105
+ descriptions: updatedCache,
106
+ lastUpdated: new Date().toISOString(),
107
+ }),
108
+ );
109
+ }
110
+
111
+ const header = `✨ Successfully cleared media descriptions`;
112
+ const detailLines = results.join("\n");
113
+
114
+ const message = [header, "", detailLines, ""].filter(Boolean).join("\n");
115
+
116
+ return {
117
+ message,
118
+ clearedCount,
119
+ };
120
+ } catch (error) {
121
+ return {
122
+ message: `Error clearing media descriptions: ${error.message}`,
123
+ error: true,
124
+ };
125
+ }
126
+ }
127
+
128
+ clearMediaDescription.taskTitle = "Clear media file descriptions";
129
+ clearMediaDescription.description = "Clear AI-generated descriptions for media files";
@@ -21,4 +21,6 @@ input_schema:
21
21
  - documentStructure
22
22
  - generatedDocs
23
23
  - documentConfig
24
- - authTokens
24
+ - authTokens
25
+ - deploymentConfig
26
+ - mediaDescription