@aigne/doc-smith 0.8.12-beta.5 → 0.8.12-beta.7

package/.aigne/doc-smith/history.yaml

@@ -0,0 +1,37 @@
+entries:
+  - timestamp: 2025-10-11T13:21:51.992Z
+    operation: translation_update
+    feedback: Do not translate the Target column in the Cleanup Targets table.
+    documentPath: /guides/cleaning-up
+  - timestamp: 2025-10-11T13:20:30.314Z
+    operation: document_update
+    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'.
+    documentPath: /guides/cleaning-up
+  - timestamp: 2025-10-11T13:03:20.327Z
+    operation: document_update
+    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'.
+    documentPath: /guides/managing-history
+  - timestamp: 2025-10-11T12:56:23.107Z
+    operation: document_update
+    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.
+    documentPath: /guides/translating-documentation
+  - timestamp: 2025-10-11T12:50:25.563Z
+    operation: document_update
+    feedback: The value of the 'docs' parameter in the demo should be a path separated by '-' rather than '/', and '.md' should be preserved.
+    documentPath: /guides/updating-documentation
+  - timestamp: 2025-10-11T12:46:37.507Z
+    operation: document_update
+    feedback: The value of the 'docs' parameter in the demo should be a path separated by '-' rather than '/'.
+    documentPath: /guides/updating-documentation
+  - timestamp: 2025-10-11T12:39:53.222Z
+    operation: document_update
+    feedback: The prompts in Review the Documentation Structure are outdated and need updating. Command Parameters also require updating.
+    documentPath: /guides/generating-documentation
+  - timestamp: 2025-10-11T12:26:24.598Z
+    operation: translation_update
+    feedback: AIGNE Framework is a proper noun and has its own link; no translation is required.
+    documentPath: /overview
+  - timestamp: 2025-10-11T12:24:05.477Z
+    operation: document_update
+    feedback: Add a link to the AIGNE Framework 'https://www.aigne.io/framework'.
+    documentPath: /overview

package/.aigne/doc-smith/preferences.yml

@@ -1,4 +1,16 @@
 rules:
+  - id: pref_cbc8005011c08ca0
+    active: true
+    scope: translation
+    rule: In the table titled 'Cleanup Targets', the 'Target' column must retain the original text and should not be translated.
+    feedback: Do not translate the Target column in the Cleanup Targets table.
+    createdAt: 2025-10-11T13:22:06.529Z
+  - id: pref_545cabc521ecd4a5
+    active: true
+    scope: translation
+    rule: The proprietary term 'AIGNE Framework' must not be translated and must be retained in its original form.
+    feedback: AIGNE Framework is a proper noun and has its own link; no translation is required.
+    createdAt: 2025-10-11T12:26:37.517Z
   - id: pref_6e612d7ca8b7f3b6
     active: true
     scope: document

package/.aigne/doc-smith/upload-cache.yaml

@@ -1861,3 +1861,33 @@ e87fcba2227e472141f99b92eb0247965db132079459ce8c83454dde7fc9a6ae:
     https://docsmith.aigne.io:
       url: https://docsmith.aigne.io/image-bin/uploads/3b189fa893cc2120.svg
       upload_time: 2025-10-10T07:40:22.634Z
+7b946c226f73c4c222b37ea23b94b3152932e1712f9d99b78f64c0b93e12bdd9:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/97b496a8d3d5b12b9c8d4d0729110db999a2be33359a1cb70b3f858997ba91a3.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/7b946c226f73c4c2.svg
+      upload_time: 2025-10-11T16:43:05.278Z
+c2a826d21a6eeb8664b88a864e1d5ae3ff68bd9e7dad3c46742f855898441747:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/44d2c5dc7e7fcf4ada941e8c4e444b19d5870dd02d44046dea585bbd77b03e0d.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/c2a826d21a6eeb86.svg
+      upload_time: 2025-10-11T16:43:06.895Z
+605705e827c243bb5402f14ed3b7750f2e6564214a81880df12b857c41935917:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/8ff7639517a76840aaf851b1345b8dae330d4df6f5788b70d2c41febf86e63ab.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/605705e827c243bb.svg
+      upload_time: 2025-10-11T16:43:06.968Z
+71ec3af141d2bcda728a2f7e7a47ca2e2e76a86f54d648832d11f4193d9975f4:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/db5b4787a2dc7655434d00ecf3eb9a25fbf73f93cda2b3f10d4022fd9c2bd16b.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/71ec3af141d2bcda.svg
+      upload_time: 2025-10-11T16:43:08.753Z
+c61907da62788c6ad5b8d89b0fde7f235046b9a6aed309c43be9b0d5b3abb670:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/8f38985e99e81e8edf973a328862e8ec33cc6de1e1382ebbe55c56f64edbd2ad.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/c61907da62788c6a.svg
+      upload_time: 2025-10-11T16:43:10.182Z

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.12-beta.5"
+  ".": "0.8.12-beta.7"
 }

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* 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))
+
+
+### Bug Fixes
+
+* 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))
+
+## [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)
+
+
+### Bug Fixes
+
+* **publish:** enhance access token retrieval and session check logic ([#178](https://github.com/AIGNE-io/aigne-doc-smith/issues/178)) ([e19e9f5](https://github.com/AIGNE-io/aigne-doc-smith/commit/e19e9f52b1c80ba8eb725cfa945cd312d0690ef1))
+
 ## [0.8.12-beta.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.4...v0.8.12-beta.5) (2025-10-11)
 
 

package/agents/generate/update-document-structure.yaml

@@ -32,11 +32,17 @@ input_schema:
     - documentStructure
     - feedback
 output_key: message
+afs:
+  modules:
+    - module: system-fs
+      options:
+        mount: /sources
+        path: .
+        description: |
+          Codebase of the project to be documented used as context for document generation,
+          should search and read as needed while generating document content
 skills:
   - ./document-structure-tools/add-document.mjs
   - ./document-structure-tools/delete-document.mjs
   - ./document-structure-tools/update-document.mjs
   - ./document-structure-tools/move-document.mjs
-  - ../update/fs-tools/glob.mjs
-  - ../update/fs-tools/grep.mjs
-  - ../update/fs-tools/read-file.mjs

package/agents/history/view.mjs

@@ -1,4 +1,5 @@
 import chalk from "chalk";
+import { createHash } from "node:crypto";
 import { getHistory } from "../../utils/history-utils.mjs";
 
 export default function viewHistory() {
@@ -35,8 +36,10 @@ export default function viewHistory() {
  * Generate a short hash from timestamp (git-style)
  */
 function generateShortHash(timestamp) {
-  const hash = timestamp.replace(/[-:.TZ]/g, "");
-  return hash.substring(hash.length - 7); // Last 7 chars
+  // Create a deterministic hash from timestamp only
+  // This ensures the same timestamp always produces the same hash
+  const hash = createHash("sha1").update(timestamp).digest("hex");
+  return hash.substring(0, 8); // First 8 chars of SHA1 hash
 }
 
 /**

package/agents/publish/publish-docs.mjs

@@ -57,18 +57,20 @@ export default async function publishDocs(
     let token = "";
 
     if (!useEnvAppUrl && isDefaultAppUrl && !hasAppUrlInConfig) {
-      const authToken = await getOfficialAccessToken(BASE_URL);
+      const authToken = await getOfficialAccessToken(BASE_URL, false);
 
-      if (!authToken) {
-        throw new Error("Failed to get official access token");
-      }
-
-      const client = new BrokerClient({ baseUrl: BASE_URL, authToken });
+      let sessionId = "";
+      let paymentLink = "";
 
-      const { sessionId, paymentLink } = await client.checkCacheSession({
-        needShortUrl: true,
-        sessionId: config?.checkoutId,
-      });
+      if (authToken) {
+        const client = new BrokerClient({ baseUrl: BASE_URL, authToken });
+        const info = await client.checkCacheSession({
+          needShortUrl: true,
+          sessionId: config?.checkoutId,
+        });
+        sessionId = info.sessionId;
+        paymentLink = info.paymentLink;
+      }
 
       const choice = await options.prompts.select({
         message: "Select platform to publish your documents:",

package/agents/update/generate-document.yaml

@@ -45,10 +45,16 @@ input_schema:
     - datasources
     - originalDocumentStructure
 output_key: content
-skills:
-  - fs-tools/glob.mjs
-  - fs-tools/grep.mjs
-  - fs-tools/read-file.mjs
+afs:
+  modules:
+    - module: system-fs
+      options:
+        mount: /sources
+        path: .
+        description: |
+          Codebase of the project to be documented used as context for document generation,
+          should search and read as needed while generating document content
+# skills:
   # FIXME: @zhanghan temporary disable diagram tool
   # - type: team
   #   task_render_mode: collapse

package/agents/update/update-document-detail.yaml

@@ -44,9 +44,15 @@ input_schema:
     - originalContent
     - feedback
 output_key: message
+afs:
+  modules:
+    - module: system-fs
+      options:
+        mount: /sources
+        path: .
+        description: |
+          Codebase of the project to be documented used as context for document generation,
+          should search and read as needed while generating document content
 skills:
   - ./document-tools/update-document-content.mjs
-  - ./fs-tools/glob.mjs
-  - ./fs-tools/grep.mjs
-  - ./fs-tools/read-file.mjs
 task_render_mode: collapse

package/agents/update/user-review-document.mjs

@@ -242,7 +242,8 @@ export default async function userReviewDocument(
         console.error(`Stack: ${error.stack}`);
       }
       console.log("\nPlease try rephrasing your feedback or continue with the current content.");
-      break;
+
+      process.exit(0);
     }
   }
 

package/docs/guides-cleaning-up.ja.md

@@ -1,49 +1,50 @@
 # クリーンアップ
 
-`aigne doc clear` コマンドは、生成されたファイル、キャッシュされたデータ、および設定を削除するための簡単な方法を提供します。これは、ドキュメントプロジェクトをリセットしたり、クリーンな状態から始めたり、古いまたは破損したファイルに関連する問題をトラブルシューティングしたりする場合に役立ちます。
+`aigne doc clear` コマンドは、生成されたファイル、キャッシュデータ、設定を削除するための簡単な方法を提供します。これは、ドキュメントプロジェクトをリセットしたり、クリーンな状態から開始したり、古くなったファイルや破損したファイルに関連する問題をトラブルシューティングしたりする場合に役立ちます。
 
 ## 対話的なクリーンアップ
 
-このコマンドを使用する最も簡単な方法は、引数なしで実行することです。
+このコマンドを使用する最も簡単な方法は、引数なしで実行することです：
 
 ```bash
 aigne doc clear
 ```
 
-このコマンドを実行すると対話型プロンプトが起動し、削除したい項目を正確に選択できます。各オプションについて明確な説明が提供され、偶発的なデータ損失を防ぐため、ほとんどのユースケースでこのアプローチが推奨されます。
+このコマンドを実行すると対話型のプロンプトが起動し、削除したい項目を正確に選択できます。各オプションについて明確な説明が提供され、偶発的なデータ損失を防ぐことができるため、ほとんどのユースケースでこのアプローチが推奨されます。
 
 ## クリーンアップ対象
 
-`clear` コマンドは、いくつかの異なる種類のデータを削除できます。次の表は、利用可能な各対象、その機能、および影響を受ける特定のファイルまたはディレクトリについて詳しく説明しています。
+`clear` コマンドは、いくつかの異なる種類のデータを削除できます。次の表は、利用可能な各ターゲット、その機能、および影響を受ける特定のファイルやディレクトリについて詳しく説明しています。
 
-| 対象 | 説明 | 影響を受けるファイルとディレクトリ |
+| Target | 説明 | 影響を受けるファイルとディレクトリ |
 | :--- | :--- | :--- |
-| **生成されたドキュメント** | ドキュメント出力ディレクトリに生成されたすべての Markdown ファイルを削除します。 | 設定で `docsDir` によって指定されたディレクトリ。 |
-| **ドキュメント構造** | 構造計画ファイルとすべての生成されたドキュメントを削除します。これにより、ドキュメントの内容が効果的にリセットされます。 | `.aigne/doc-smith/output/structure-plan.json` ファイルと `docsDir` ディレクトリ。 |
-| **ドキュメント設定** | プロジェクトの設定ファイルを削除します。これを実行した後、プロジェクトを再初期化する必要があります。 | `.aigne/doc-smith/config.yaml` ファイル。 |
-| **認証情報** | ドキュメントを公開するために使用される保存済みの認証トークンを削除します。クリアする特定のサイトを選択するように求められます。 | ホームディレクトリにある `~/.aigne/doc-smith-connected.yaml` ファイル。 |
+| `generatedDocs` | 出力ディレクトリ内の生成されたすべてのドキュメントを削除しますが、ドキュメント構造計画は保持します。 | 設定で指定された `docsDir` ディレクトリ。 |
+| `documentStructure` | 生成されたすべてのドキュメントとドキュメント構造計画を削除し、ドキュメントコンテンツを効果的にリセットします。 | `.aigne/doc-smith/output/structure-plan.json` ファイルと `docsDir` ディレクトリ。 |
+| `documentConfig` | プロジェクトの設定ファイルを削除します。この操作の後、再度 `aigne doc init` を実行する必要があります。 | `.aigne/doc-smith/config.yaml` ファイル。 |
+| `authTokens` | 公開サイト用に保存された認証トークンを削除します。どのサイトをクリアするか選択するよう求められます。 | ホームディレクトリにある `~/.aigne/doc-smith-connected.yaml` ファイル。 |
+| `deploymentConfig` | 設定ファイルから `appUrl` を削除します。 | `.aigne/doc-smith/config.yaml` ファイル。 |
 
 ## 非対話的なクリーンアップ
 
-自動化スクリプトやコマンドラインを好むユーザー向けに、`--targets` フラグを使用してクリアする対象を1つ以上直接指定できます。これにより、対話型プロンプトがバイパスされます。
+自動化スクリプトやコマンドラインを好むユーザーのために、`--targets` フラグを使用してクリアする1つ以上のターゲットを直接指定できます。これにより、対話型のプロンプトがバイパスされます。
 
-### 単一の対象をクリア
+### 単一ターゲットのクリア
 
-生成されたドキュメントのみをクリアするには、次のコマンドを使用します。
+生成されたドキュメントのみをクリアするには、次のコマンドを使用します：
 
 ```bash
 aigne doc clear --targets generatedDocs
 ```
 
-### 複数の対象をクリア
+### 複数ターゲットのクリア
 
-複数の対象名を指定して、一度にいくつかの項目をクリアできます。例えば、ドキュメント設定とドキュメント構造の両方を削除するには、次のように実行します。
+複数のターゲット名を指定して、一度に複数の項目をクリアできます。例えば、ドキュメント設定とドキュメント構造の両方を削除するには、次のように実行します：
 
 ```bash
 aigne doc clear --targets documentConfig documentStructure
 ```
 
-設定をクリアした後、セットアッププロセスを再度実行して、新たに始めることができます。
+設定をクリアした後、再度セットアッププロセスを実行して新たに開始できます。
 
 ---
 

package/docs/guides-cleaning-up.md

@@ -18,10 +18,11 @@ The `clear` command can remove several distinct types of data. The following tab
 
 | Target | Description | Files and Directories Affected |
 | :--- | :--- | :--- |
-| **Generated Documents** | Deletes all Markdown files that were generated in your documentation output directory. | The directory specified by `docsDir` in your configuration. |
-| **Documentation Structure** | Deletes the structure plan file and all generated documents. This effectively resets your documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
-| **Document Configuration** | Deletes the project's configuration file. After running this, you will need to re-initialize the project. | The `.aigne/doc-smith/config.yaml` file. |
-| **Authorizations** | Removes saved authorization tokens used for publishing your documentation. You will be prompted to select specific sites to clear. | The `~/.aigne/doc-smith-connected.yaml` file in your home directory. |
+| `generatedDocs` | Deletes all generated documents in your output directory, but keeps the documentation structure plan. | The directory specified by `docsDir` in your configuration. |
+| `documentStructure` | Deletes all generated documents and the documentation structure plan, effectively resetting your documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
+| `documentConfig` | Deletes the project's configuration file. You will need to run `aigne doc init` again after this. | The `.aigne/doc-smith/config.yaml` file. |
+| `authTokens` | Removes saved authorization tokens for publishing sites. You will be prompted to select which sites to clear. | The `~/.aigne/doc-smith-connected.yaml` file in your home directory. |
+| `deploymentConfig` | Deletes the `appUrl` from your configuration file. | The `.aigne/doc-smith/config.yaml` file. |
 
 ## Non-Interactive Cleaning
 

package/docs/guides-cleaning-up.zh-TW.md

@@ -1,49 +1,50 @@
 # 清理
 
-`aigne doc clear` 指令提供了一種直接的方法，用於移除生成的檔案、快取資料和配置設定。當您想重設文件專案、從乾淨的狀態開始，或解決與過時或損壞檔案相關的問題時，此功能非常有用。
+`aigne doc clear` 指令提供了一個直接的方法來移除生成的檔案、快取資料和配置設定。當您想要重設您的文件專案、從乾淨的狀態開始，或解決與過時或損壞檔案相關的問題時，這個指令非常有用。
 
 ## 互動式清理
 
-使用此指令最簡單的方法就是不帶任何參數直接執行：
+使用此指令最簡單的方法是不帶任何參數直接執行：
 
 ```bash
 aigne doc clear
 ```
 
-執行此指令將會啟動一個互動式提示，讓您能精確選擇要移除的項目。對於大多數使用情境而言，這是建議的方法，因為它為每個選項提供了清晰的說明，並能防止意外的資料遺失。
+執行此指令將啟動一個互動式提示，讓您精確選擇要移除的項目。這是大多數使用情境下的建議方法，因為它為每個選項提供了清晰的說明，並能防止意外的資料遺失。
 
 ## 清理目標
 
-`clear` 指令可以移除幾種不同類型的資料。下表詳細說明了每個可用的目標、其功能，以及它所影響的特定檔案或目錄。
+`clear` 指令可以移除幾種不同類型的資料。下表詳細說明了每個可用的目標、其功能以及它所影響的特定檔案或目錄。
 
-| 目標 | 說明 | 受影響的檔案和目錄 |
+| Target | 說明 | 受影響的檔案與目錄 |
 | :--- | :--- | :--- |
-| **生成的檔案** | 刪除在您的文件輸出目錄中生成的所有 Markdown 檔案。 | 您的配置中由 `docsDir` 指定的目錄。 |
-| **文件結構** | 刪除結構計畫檔案和所有生成的檔案。這能有效地重設您的文件內容。 | `.aigne/doc-smith/output/structure-plan.json` 檔案和 `docsDir` 目錄。 |
-| **文件配置** | 刪除專案的設定檔。執行此操作後，您將需要重新初始化專案。 | `.aigne/doc-smith/config.yaml` 檔案。 |
-| **授權** | 移除用於發布文件的已儲存授權權杖。系統將提示您選擇要清除授權的特定網站。 | 您家目錄中的 `~/.aigne/doc-smith-connected.yaml` 檔案。 |
+| `generatedDocs` | 刪除您輸出目錄中所有已生成的檔案，但保留文件結構計畫。 | 您設定中 `docsDir` 所指定的目錄。 |
+| `documentStructure` | 刪除所有已生成的檔案和文件結構計畫，有效地重設您的文件內容。 | `.aigne/doc-smith/output/structure-plan.json` 檔案和 `docsDir` 目錄。 |
+| `documentConfig` | 刪除專案的設定檔。此操作後，您將需要重新執行 `aigne doc init`。 | `.aigne/doc-smith/config.yaml` 檔案。 |
+| `authTokens` | 移除已儲存的發布網站授權權杖。系統將提示您選擇要清除哪些網站。 | 您家目錄中的 `~/.aigne/doc-smith-connected.yaml` 檔案。 |
+| `deploymentConfig` | 從您的設定檔中刪除 `appUrl`。 | `.aigne/doc-smith/config.yaml` 檔案。 |
 
 ## 非互動式清理
 
-對於自動化腳本或偏好使用命令列的使用者，您可以使用 `--targets` 旗標直接指定一個或多個要清理的目標。這將會繞過互動式提示。
+對於自動化腳本或偏好使用命令列的使用者，您可以使用 `--targets` 旗標直接指定一個或多個要清除的目標。這將繞過互動式提示。
 
-### 清理單一目標
+### 清除單一目標
 
-若要僅清理生成的檔案，請使用以下指令：
+若要僅清除已生成的檔案，請使用以下指令：
 
 ```bash
 aigne doc clear --targets generatedDocs
 ```
 
-### 清理多個目標
+### 清除多個目標
 
-您可以提供多個目標名稱來一次性清理多個項目。例如，若要同時移除文件配置和文件結構，請執行：
+您可以提供多個目標名稱來一次清除多個項目。例如，若要同時移除文件設定和文件結構，請執行：
 
 ```bash
 aigne doc clear --targets documentConfig documentStructure
 ```
 
-清理完配置後，您可以再次執行設定流程以重新開始。
+清除您的設定後，您可以再次執行設定流程以重新開始。
 
 ---
 

package/docs/guides-cleaning-up.zh.md

@@ -1,6 +1,6 @@
 # 清理
 
-`aigne doc clear` 命令提供了一种直接的方法，用于移除生成的文件、缓存数据和配置设置。当您想要重置文档项目、从一个干净的状态开始，或者排查与过时或损坏文件相关的问题时，这个命令非常有用。
+`aigne doc clear` 命令提供了一种简单直接的方法来移除生成的文件、缓存数据和配置设置。当您想要重置文档项目、从干净的状态开始或排查与过时或损坏文件相关的问题时，这个命令非常有用。
 
 ## 交互式清理
 
@@ -10,22 +10,23 @@
 aigne doc clear
 ```
 
-执行此命令将启动一个交互式提示，让您精确选择要移除的项目。这是大多数用例的推荐方法，因为它为每个选项提供了清晰的描述，并能防止意外的数据丢失。
+执行此命令将启动一个交互式提示，让您能够精确选择要移除的项目。这是大多数用例的推荐方法，因为它为每个选项提供了清晰的描述，并能防止意外的数据丢失。
 
 ## 清理目标
 
-`clear` 命令可以移除几种不同类型的数据。下表详细介绍了每个可用目标、其功能以及它影响的具体文件或目录。
+`clear` 命令可以移除几种不同类型的数据。下表详细说明了每个可用的目标、其功能以及所影响的具体文件或目录。
 
-| 目标 | 描述 | 受影响的文件和目录 |
+| Target | Description | Files and Directories Affected |
 | :--- | :--- | :--- |
-| **生成的文档** | 删除在您的文档输出目录中生成的所有 Markdown 文件。 | 您的配置中由 `docsDir` 指定的目录。 |
-| **文档结构** | 删除结构计划文件和所有生成的文档。这将有效地重置您的文档内容。 | `.aigne/doc-smith/output/structure-plan.json` 文件和 `docsDir` 目录。 |
-| **文档配置** | 删除项目的配置文件。运行此操作后，您需要重新初始化项目。 | `.aigne/doc-smith/config.yaml` 文件。 |
-| **授权** | 移除用于发布文档的已保存授权令牌。系统将提示您选择要清除授权的特定站点。 | 您主目录下的 `~/.aigne/doc-smith-connected.yaml` 文件。 |
+| `generatedDocs` | 删除输出目录中所有生成的文档，但保留文档结构计划。 | 您配置中由 `docsDir` 指定的目录。 |
+| `documentStructure` | 删除所有生成的文档和文档结构计划，从而有效重置您的文档内容。 | `.aigne/doc-smith/output/structure-plan.json` 文件和 `docsDir` 目录。 |
+| `documentConfig` | 删除项目的配置文件。执行此操作后，您需要重新运行 `aigne doc init`。 | `.aigne/doc-smith/config.yaml` 文件。 |
+| `authTokens` | 移除已保存的用于发布站点的授权令牌。系统将提示您选择要清除哪些站点。 | 您主目录下的 `~/.aigne/doc-smith-connected.yaml` 文件。 |
+| `deploymentConfig` | 从您的配置文件中删除 `appUrl`。 | `.aigne/doc-smith/config.yaml` 文件。 |
 
 ## 非交互式清理
 
-对于自动化脚本或偏好命令行的用户，您可以使用 `--targets` 标志直接指定一个或多个要清理的目标。这将绕过交互式提示。
+对于自动化脚本或偏好使用命令行的用户，您可以使用 `--targets` 标志直接指定一个或多个要清理的目标。这将绕过交互式提示。
 
 ### 清理单个目标
 
@@ -43,8 +44,8 @@ aigne doc clear --targets generatedDocs
 aigne doc clear --targets documentConfig documentStructure
 ```
 
-清理配置后，您可以再次运行设置过程以重新开始。
+清理配置后，您可以通过再次运行设置过程来重新开始。
 
 ---
 
-有关初始设置的更多信息，请参阅[初始设置](./configuration-initial-setup.md)指南。
+有关初始设置的更多信息，请参阅 [初始设置](./configuration-initial-setup.md) 指南。

package/docs/guides-generating-documentation.ja.md

@@ -1,12 +1,12 @@
 # ドキュメントの生成
 
-このガイドでは、プロジェクトのソースファイルからドキュメント一式を作成するための体系的な手順を説明します。このプロセスは `aigne doc generate` コマンドを使用して開始されます。このコマンドはコードベースを分析し、論理的な構造を提案し、各ドキュメントのコンテンツを作成します。
+このガイドでは、プロジェクトのソースファイルから完全なドキュメント一式を作成するための体系的な手順を説明します。このプロセスは `aigne doc generate` コマンドを使用して開始します。このコマンドはコードベースを分析し、論理的な構造を提案し、各ドキュメントのコンテンツを書き込みます。
 
-このコマンドは、ドキュメントを最初に作成するための主要なツールです。作成後のドキュメントの修正については、[ドキュメントの更新](./guides-updating-documentation.md)ガイドを参照してください。
+このコマンドは、ドキュメントを最初に作成するための主要なツールです。作成済みのドキュメントを修正する場合は、[ドキュメントの更新](./guides-updating-documentation.md)ガイドを参照してください。
 
-### 生成のワークフロー
+### 生成ワークフロー
 
-`generate` コマンドは、ドキュメントを構築するための一連の自動化されたステップを実行します。このプロセスは対話形式で設計されており、コンテンツが書き込まれる前に提案された構造を確認し、承認することができます。
+`generate` コマンドは、ドキュメントを構築するための一連の自動化されたステップを実行します。このプロセスは対話形式で設計されており、コンテンツが書き込まれる前に、提案された構造を確認・承認できます。
 
 ```d2
 direction: down
@@ -22,12 +22,12 @@ run_command: {
 }
 
 check_config: {
-  label: "設定ファイルが存在するか？"
+  label: "設定ファイルは存在するか？"
   shape: diamond
 }
 
 interactive_setup: {
-  label: "対話型セットアップのガイド"
+  label: "対話型セットアップをガイド"
   shape: rectangle
   tooltip: ".aigne/doc-smith/config.yaml が見つからない場合、対話型セットアップがトリガーされます。"
 }
@@ -43,14 +43,14 @@ review_structure: {
 }
 
 user_approve: {
-  label: "構造を承認しますか？"
+  label: "構造を承認するか？"
   shape: diamond
 }
 
 provide_feedback: {
-  label: "構造を改善するためのフィードバックを提供"
+  label: "構造を洗練させるためのフィードバックを提供"
   shape: rectangle
-  tooltip: "ユーザーは、セクションの名前の変更、追加、削除などの変更を要求できます。"
+  tooltip: "ユーザーはセクションの名前変更、追加、削除などの変更を要求できます。"
 }
 
 generate_content: {
@@ -88,61 +88,63 @@ generate_content -> end
 
 ドキュメントを生成するには、ターミナルでプロジェクトのルートディレクトリに移動し、以下の手順に従ってください。
 
-### 1. Generate コマンドの実行
+### 1. 生成コマンドの実行
 
-`generate` コマンドを実行してプロセスを開始します。ツールはプロジェクトのファイルと構造の分析から開始します。
+`generate` コマンドを実行してプロセスを開始します。ツールはプロジェクトのファイルと構造の分析から始めます。
 
 ```bash 基本的な生成コマンド
 aigne doc generate
 ```
 
-簡潔にするために、エイリアス `gen` または `g` を使用することもできます。
+簡潔にするために、エイリアスの `gen` や `g` を使用することもできます。
 
 ### 2. ドキュメント構造の確認
 
-分析が完了すると、ツールは提案されたドキュメント構造を提示します。この構造は、作成されるドキュメントの階層的な計画です。
-
-この計画を確認するよう求められます。
+分析が完了すると、ツールは提案されたドキュメント構造を表示し、確認を求めます。
 
 ```
-ドキュメントの構造を最適化しますか？
-タイトルを編集したり、セクションを再編成したりできます。
-❯ 問題ありません - 現在の構造で続行します
-  はい、構造を最適化します
+ドキュメント構造を最適化しますか？
+❯ いいえ、問題ありません
+  はい、構造を最適化します（例：「はじめに」を「クイックスタート」に名称変更、「APIリファレンス」を「設定」の前に移動するなど）
 ```
 
--   **問題ありません - 現在の構造で続行します**: このオプションを選択すると、提案された構造を承認し、直接コンテンツ生成に進みます。
--   **はい、構造を最適化します**: このオプションは、計画を修正したい場合に選択します。プレーンテキストで、「'API' を 'API リファレンス' に変更」や「'デプロイ' のための新しいセクションを追加」などのフィードバックを提供できます。AI はあなたのフィードバックに基づいて構造を修正し、再度確認することができます。このサイクルは、構造があなたの要件を満たすまで繰り返すことができます。
+-   **いいえ、問題ありません**: このオプションを選択すると、提案された構造を承認し、直接コンテンツ生成に進みます。
+-   **はい、構造を最適化します**: このオプションを選択すると、プランを修正できます。ツールは対話ループでフィードバックを求めます。次のようなプレーンテキストで指示を与えることができます。
+    -   `「トラブルシューティング」という新しいドキュメントを追加`
+    -   `「レガシー機能」ドキュメントを削除`
+    -   `「インストール」を構造の最上部に移動`
+
+    フィードバックのたびに、AIが構造を修正し、再度確認できます。フィードバックを入力せずにEnterキーを押すと、ループを終了して最終的な構造を承認します。
 
 ### 3. コンテンツの生成
 
-ドキュメント構造が承認されると、DocSmith は計画内の各ドキュメントの詳細なコンテンツの生成を開始します。このプロセスは自動的に実行され、その所要時間はプロジェクトの規模と複雑さによって異なります。
+ドキュメント構造が承認されると、DocSmithはプラン内の各ドキュメントの詳細なコンテンツの生成を開始します。このプロセスは自動的に実行され、所要時間はプロジェクトの規模と複雑さによって異なります。
 
 完了すると、生成されたファイルは設定で指定された出力ディレクトリ（例：`./docs`）に保存されます。
 
-## コマンドのパラメータ
+## コマンドパラメータ
 
 `generate` コマンドは、その動作を制御するためのいくつかのオプションパラメータを受け入れます。
 
-| パラメータ          | 説明                                                                                                                                     | 例                                                                                  |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `--forceRegenerate` | 既存の構造やコンテンツをすべて無視して、すべてのドキュメントをゼロから再構築します。これは、白紙の状態からやり直す場合に便利です。             | `aigne doc generate --forceRegenerate`                                              |
-| `--feedback`        | 構造生成フェーズで AI をガイドするための初期指示を提供します。                                                                             | `aigne doc generate --feedback "API の例を増やし、トラブルシューティングのセクションを追加してください"` |
-| `--glossary`        | ドキュメント全体で一貫した用語の使用を保証するために、用語集ファイル（`.md`）を指定します。                                                  | `aigne doc generate --glossary @/path/to/glossary.md`                             |
+| パラメータ | 説明 | 例 |
+|---|---|---|
+| `--forceRegenerate` | 既存の構造やコンテンツをすべて無視して、すべてのドキュメントを最初から再構築します。完全にリセットしたい場合に便利です。 | `aigne doc generate --forceRegenerate` |
+| `--feedback` | 対話型の確認が始まる前に、構造生成フェーズでAIをガイドするための初期のテキストベースの指示を提供します。 | `aigne doc generate --feedback "Add more API examples"` |
+| `--glossary` | 用語集ファイル（例：`glossary.md`）を指定して、ドキュメント全体で一貫した用語の使用を保証します。 | `aigne doc generate --glossary @/path/to/glossary.md` |
 
-### 例：完全な再構築を強制する
+### 例：完全な再構築の強制
 
 以前に生成されたすべてのドキュメントを破棄し、コードの現在の状態に基づいて新しいセットを作成したい場合は、`--forceRegenerate` フラグを使用します。
 
-```bash 再生成の強制
+```bash 再構築の強制
 aigne doc generate --forceRegenerate
 ```
 
 ## まとめ
 
-`generate` コマンドは、初期プロジェクトドキュメントを作成するプロセス全体を統括します。自動化されたコード分析と対話的なレビュープロセスを組み合わせることで、構造化された関連性の高いドキュメント一式を生成します。
+`generate` コマンドは、初期プロジェクトドキュメントを作成するプロセス全体を統括します。自動化されたコード分析と対話型の確認プロセスを組み合わせることで、構造化された関連性の高いドキュメント一式を生成します。
 
-ドキュメントが生成された後、次のことを行うことができます。
+ドキュメントが生成されたら、次のような操作ができます。
 
 -   [ドキュメントの更新](./guides-updating-documentation.md): 特定のドキュメントに変更を加える。
 -   [ドキュメントの翻訳](./guides-translating-documentation.md): コンテンツを他の言語に翻訳する。