@aigne/doc-smith 0.8.12-beta.2 → 0.8.12-beta.4

package/docs/cli-reference.ja.md

@@ -1,311 +0,0 @@
-# CLIコマンドリファレンス
-
-このガイドは、利用可能なすべての`aigne doc`サブコマンド、その引数、およびオプションに関する包括的なリファレンスを提供します。コマンドラインインターフェースを最大限に活用したいユーザーを対象としています。
-
-一般的な構文は次のとおりです：
-
-```bash command icon=lucide:terminal
-aigne doc <command> [options]
-```
-
-### コマンドのワークフロー
-
-以下の図は、DocSmithのCLIコマンドを使用してドキュメントを作成および維持する一般的なライフサイクルと、それらが相互作用するデータを示しています。
-
-```d2
-direction: down
-
-# Artifacts
-Source-Code: {
-  label: "ソースコード"
-  shape: cylinder
-}
-Configuration: {
-  label: "設定\n(.aigne/doc-smith/config.yml)"
-  shape: cylinder
-}
-Generated-Docs: {
-  label: "生成されたドキュメント"
-  shape: cylinder
-}
-Published-Docs: {
-  label: "公開されたサイト"
-  shape: cylinder
-}
-
-# --- Core Workflow ---
-Lifecycle: {
-  label: "ドキュメントのライフサイクル"
-  
-  init: {
-    label: "1. 初期化\n`aigne doc init`"
-    shape: rectangle
-  }
-
-  generate: {
-    label: "2. 生成\n`aigne doc generate`"
-    shape: rectangle
-  }
-
-  Refinement: {
-    label: "3. 改良 (反復)"
-    grid-columns: 2
-
-    update: {
-      label: "更新\n`aigne doc update`"
-      shape: rectangle
-    }
-    translate: {
-      label: "翻訳\n`aigne doc translate`"
-      shape: rectangle
-    }
-  }
-
-  publish: {
-    label: "4. 公開\n`aigne doc publish`"
-    shape: rectangle
-  }
-}
-
-# --- Utility Commands ---
-Utilities: {
-  label: "ユーティリティコマンド"
-  grid-columns: 2
-  
-  prefs: {
-    label: "設定管理\n`aigne doc prefs`"
-    shape: rectangle
-  }
-  clear: {
-    label: "データ消去\n`aigne doc clear`"
-    shape: rectangle
-  }
-}
-
-
-# --- Connections ---
-
-# Setup and Generation
-Lifecycle.init -> Configuration: "作成"
-Source-Code -> Lifecycle.generate: "読み込み"
-Configuration -> Lifecycle.generate: "読み込み"
-Lifecycle.generate -> Generated-Docs: "作成 / 上書き"
-Lifecycle.generate -> Lifecycle.init: {
-  label: "設定がない場合に実行"
-  style.stroke-dash: 4
-}
-
-# Refinement Loop
-Generated-Docs <-> Lifecycle.Refinement: "読み書き"
-
-# Publishing
-Lifecycle.Refinement -> Lifecycle.publish
-Lifecycle.publish -> Published-Docs: "アップロード"
-
-# Utility Connections
-Utilities.prefs -> Configuration: "読み込み"
-Utilities.clear -> Configuration: "削除"
-Utilities.clear -> Generated-Docs: "削除"
-```
-
----
-
-## `aigne doc init`
-
-対話式の設​​定ウィザードを手動で開始します。これは、新しいプロジェクトをセットアップしたり、既存のプロジェクトの構成を変更したりするのに役立ちます。ウィザードは、ソースコードのパスの定義、出力ディレクトリの設定、言語の選択、ドキュメントのスタイルと対象読者の定義をガイドします。
-
-### 使用例
-
-**セットアップウィザードを起動します：**
-
-```bash
-aigne doc init
-```
-![対話型セットアップウィザード完了のスクリーンショット。](../assets/screenshots/doc-complete-setup.png)
-
-DocSmithをニーズに合わせて調整する方法の詳細については、[設定ガイド](./configuration.md)を参照してください。
-
----
-
-## `aigne doc generate`
-
-ソースコードを分析し、設定に基づいて完全なドキュメントセットを生成します。設定が見つからない場合は、自動的に対話式のセットアップウィザード（`aigne doc init`）を起動します。
-
-![generateコマンド実行中のスクリーンショット。](../assets/screenshots/doc-generate.png)
-
-### オプション
-
-| オプション | タイプ | 説明 |
-| :------------------ | :------ | :------------------------------------------------------------------------------------------------------- |
-| `--forceRegenerate` | boolean | 既存のコンテンツを破棄し、すべてのドキュメントを最初から再生成します。 |
-| `--feedback` | string | ドキュメント全体の構造を調整・改良するためのフィードバックを提供します。 |
-| `--model` | string | 生成に使用する特定の言語モデルを指定します（例：`openai:gpt-4o`）。デフォルト設定を上書きします。 |
-
-### 使用例
-
-**ドキュメントを生成または更新します：**
-
-```bash
-aigne doc generate
-```
-
-**すべてのドキュメントの完全な再生成を強制します：**
-
-```bash
-aigne doc generate --forceRegenerate
-```
-
-**フィードバックを反映してドキュメント構造を改良します：**
-
-```bash
-aigne doc generate --feedback "APIの例のセクションを新しく追加し、「概要」ページを削除してください。"
-```
-
-**特定のモデルを使用して生成します：**
-
-```bash
-aigne doc generate --model openai:gpt-4o
-```
-
----
-
-## `aigne doc update`
-
-特定のドキュメントを最適化し、再生成します。対話形式で実行してドキュメントを選択するか、オプションで直接指定できます。これは、プロジェクト全体を再生成することなく、フィードバックに基づいて的を絞った改善を行うのに役立ちます。
-
-![updateコマンド実行中のスクリーンショット。](../assets/screenshots/doc-update.png)
-
-### オプション
-
-| オプション | タイプ | 説明 |
-| :--------- | :---- | :-------------------------------------------------------------------------- |
-| `--docs` | array | 再生成するドキュメントのパスのリスト。複数回指定できます。 |
-| `--feedback` | string | 選択したドキュメントのコンテンツを改善するための具体的なフィードバックを提供します。 |
-
-### 使用例
-
-**対話セッションを開始して更新するドキュメントを選択します：**
-
-```bash
-aigne doc update
-```
-
-**特定のドキュメントを的を絞ったフィードバックで更新します：**
-
-```bash
-aigne doc update --docs /overview --feedback "より詳細なFAQ項目を追加してください"
-```
-
----
-
-## `aigne doc translate`
-
-既存のドキュメントを1つ以上の言語に翻訳します。対話形式で実行してドキュメントや言語を選択することも、引数として指定して非対話形式で実行することもできます。
-
-![translateコマンド実行中のスクリーンショット。](../assets/screenshots/doc-translate.png)
-
-### オプション
-
-| オプション | タイプ | 説明 |
-| :--------- | :---- | :----------------------------------------------------------------------------------- |
-| `--docs` | array | 翻訳するドキュメントのパスのリスト。複数回指定できます。 |
-| `--langs` | array | 翻訳先の言語コードのリスト（例：`zh-CN`、`ja`）。複数回指定できます。 |
-| `--feedback` | string | 翻訳の質を向上させるためのフィードバックを提供します。 |
-| `--glossary` | string | 言語間で一貫した用語を確保するための用語集ファイルへのパス。`@path/to/glossary.md`を使用します。 |
-
-### 使用例
-
-**対話式の翻訳セッションを開始します：**
-
-```bash
-aigne doc translate
-```
-
-**特定のドキュメントを中国語と日本語に翻訳します：**
-
-```bash
-aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation --docs /overview
-```
-
-**用語集とフィードバックを使用して翻訳品質を向上させます：**
-
-```bash
-aigne doc translate --glossary @glossary.md --feedback "技術用語を一貫して使用してください"
-```
-
----
-
-## `aigne doc publish`
-
-ドキュメントを公開し、共有可能なリンクを生成します。このコマンドは、コンテンツをDiscuss Kitインスタンスにアップロードします。公式のAIGNE DocSmithプラットフォームを使用するか、独自の[Discuss Kit](https://www.web3kit.rocks/discuss-kit)インスタンスを実行できます。
-
-![publishコマンド実行中のスクリーンショット。](../assets/screenshots/doc-publish.png)
-
-### オプション
-
-| オプション | タイプ | 説明 |
-| :------- | :----- | :------------------------------------------------------------------------------------------------------ |
-| `--appUrl` | string | セルフホストしているDiscuss KitインスタンスのURL。指定しない場合、コマンドは対話形式で実行されます。 |
-
-### 使用例
-
-**対話式の公開セッションを開始します：**
-
-```bash
-aigne doc publish
-```
-
-**セルフホストのインスタンスに直接公開します：**
-
-```bash
-aigne doc publish --appUrl https://your-discuss-kit-instance.com
-```
-
----
-
-## `aigne doc prefs`
-
-ユーザー設定とフィードバックに基づくルールを管理します。DocSmithは時間とともにフィードバックから学習し、永続的な設定を作成します。このコマンドを使用すると、これらの学習済みルールを表示、切り替え、または削除できます。
-
-### オプション
-
-| オプション | タイプ | 説明 |
-| :------- | :------ | :------------------------------------------------------------------------- |
-| `--list` | boolean | 保存されているすべての設定を一覧表示します。 |
-| `--remove` | boolean | 対話形式で1つ以上の設定を選択して削除するように促します。 |
-| `--toggle` | boolean | 対話形式で設定を選択し、その有効状態を切り替えるように促します。 |
-| `--id` | array | 直接削除または切り替える1つ以上の設定IDを指定します。 |
-
-### 使用例
-
-**保存されているすべての設定を一覧表示します：**
-
-```bash
-aigne doc prefs --list
-```
-
-**対話式の削除モードを開始します：**
-
-```bash
-aigne doc prefs --remove
-```
-
-**IDで特定の設定を切り替えます：**
-
-```bash
-aigne doc prefs --toggle --id "pref_2a1dfe2b09695aab"
-```
-
----
-
-## `aigne doc clear`
-
-ローカルに保存されたデータを消去するための対話セッションを起動します。これを使用して、生成されたドキュメント、ドキュメント構造の設定、またはキャッシュされた認証トークンを削除できます。
-
-### 使用例
-
-**対話式のクリーンアッププロセスを開始します：**
-
-```bash
-aigne doc clear
-```

package/docs/cli-reference.md

@@ -1,311 +0,0 @@
-# CLI Command Reference
-
-This guide provides a comprehensive reference for all available `aigne doc` sub-commands, their arguments, and options. It is intended for users who want to utilize the command-line interface to its full potential.
-
-The general syntax is:
-
-```bash command icon=lucide:terminal
-aigne doc <command> [options]
-```
-
-### Command Workflow
-
-The following diagram illustrates the typical lifecycle of creating and maintaining documentation with DocSmith's CLI commands, along with the data they interact with.
-
-```d2
-direction: down
-
-# Artifacts
-Source-Code: {
-  label: "Source Code"
-  shape: cylinder
-}
-Configuration: {
-  label: "Configuration\n(.aigne/doc-smith/config.yml)"
-  shape: cylinder
-}
-Generated-Docs: {
-  label: "Generated Docs"
-  shape: cylinder
-}
-Published-Docs: {
-  label: "Published Site"
-  shape: cylinder
-}
-
-# --- Core Workflow ---
-Lifecycle: {
-  label: "Documentation Lifecycle"
-  
-  init: {
-    label: "1. Init\n`aigne doc init`"
-    shape: rectangle
-  }
-
-  generate: {
-    label: "2. Generate\n`aigne doc generate`"
-    shape: rectangle
-  }
-
-  Refinement: {
-    label: "3. Refine (Iterative)"
-    grid-columns: 2
-
-    update: {
-      label: "Update\n`aigne doc update`"
-      shape: rectangle
-    }
-    translate: {
-      label: "Translate\n`aigne doc translate`"
-      shape: rectangle
-    }
-  }
-
-  publish: {
-    label: "4. Publish\n`aigne doc publish`"
-    shape: rectangle
-  }
-}
-
-# --- Utility Commands ---
-Utilities: {
-  label: "Utility Commands"
-  grid-columns: 2
-  
-  prefs: {
-    label: "Manage Prefs\n`aigne doc prefs`"
-    shape: rectangle
-  }
-  clear: {
-    label: "Clear Data\n`aigne doc clear`"
-    shape: rectangle
-  }
-}
-
-
-# --- Connections ---
-
-# Setup and Generation
-Lifecycle.init -> Configuration: "Creates"
-Source-Code -> Lifecycle.generate: "Reads"
-Configuration -> Lifecycle.generate: "Reads"
-Lifecycle.generate -> Generated-Docs: "Creates / Overwrites"
-Lifecycle.generate -> Lifecycle.init: {
-  label: "Runs if no config"
-  style.stroke-dash: 4
-}
-
-# Refinement Loop
-Generated-Docs <-> Lifecycle.Refinement: "Reads & Writes"
-
-# Publishing
-Lifecycle.Refinement -> Lifecycle.publish
-Lifecycle.publish -> Published-Docs: "Uploads to"
-
-# Utility Connections
-Utilities.prefs -> Configuration: "Reads"
-Utilities.clear -> Configuration: "Deletes"
-Utilities.clear -> Generated-Docs: "Deletes"
-```
-
----
-
-## `aigne doc init`
-
-Manually starts the interactive configuration wizard. This is useful for setting up a new project or modifying the configuration of an existing one. The wizard guides you through defining source code paths, setting output directories, choosing languages, and defining the documentation's style and target audience.
-
-### Usage Example
-
-**Launch the setup wizard:**
-
-```bash
-aigne doc init
-```
-![Screenshot of the interactive setup wizard completion.](../assets/screenshots/doc-complete-setup.png)
-
-For more details on how to tailor DocSmith to your needs, see the [Configuration Guide](./configuration.md).
-
----
-
-## `aigne doc generate`
-
-Analyzes your source code and generates a complete set of documentation based on your configuration. If no configuration is found, it automatically launches the interactive setup wizard (`aigne doc init`).
-
-![Screenshot of the generate command running.](../assets/screenshots/doc-generate.png)
-
-### Options
-
-| Option              | Type    | Description                                                                                              |
-| :------------------ | :------ | :------------------------------------------------------------------------------------------------------- |
-| `--forceRegenerate` | boolean | Discards existing content and regenerates all documentation from scratch.                                |
-| `--feedback`        | string  | Provides feedback to adjust and refine the overall documentation structure.                              |
-| `--model`           | string  | Specifies a particular large language model to use for generation (e.g., `openai:gpt-4o`). Overrides the default. |
-
-### Usage Examples
-
-**Generate or update documentation:**
-
-```bash
-aigne doc generate
-```
-
-**Force a complete regeneration of all documents:**
-
-```bash
-aigne doc generate --forceRegenerate
-```
-
-**Refine the documentation structure with feedback:**
-
-```bash
-aigne doc generate --feedback "Add a new section for API examples and remove the 'About' page."
-```
-
-**Generate using a specific model:**
-
-```bash
-aigne doc generate --model openai:gpt-4o
-```
-
----
-
-## `aigne doc update`
-
-Optimizes and regenerates specific documents. You can run it interactively to select documents or specify them directly with options. This is useful for making targeted improvements based on feedback without regenerating the entire project.
-
-![Screenshot of the update command running.](../assets/screenshots/doc-update.png)
-
-### Options
-
-| Option     | Type  | Description                                                                 |
-| :--------- | :---- | :-------------------------------------------------------------------------- |
-| `--docs`     | array | A list of document paths to regenerate. Can be specified multiple times.    |
-| `--feedback` | string  | Provides specific feedback to improve the content of the selected document(s). |
-
-### Usage Examples
-
-**Start an interactive session to select a document to update:**
-
-```bash
-aigne doc update
-```
-
-**Update a specific document with targeted feedback:**
-
-```bash
-aigne doc update --docs /overview --feedback "Add more detailed FAQ entries"
-```
-
----
-
-## `aigne doc translate`
-
-Translates existing documentation into one or more languages. It can be run interactively to select documents and languages, or non-interactively by specifying them as arguments.
-
-![Screenshot of the translate command running.](../assets/screenshots/doc-translate.png)
-
-### Options
-
-| Option     | Type  | Description                                                                          |
-| :--------- | :---- | :----------------------------------------------------------------------------------- |
-| `--docs`     | array | A list of document paths to translate. Can be specified multiple times.              |
-| `--langs`    | array | A list of target language codes (e.g., `zh-CN`, `ja`). Can be specified multiple times. |
-| `--feedback` | string  | Provides feedback to improve the quality of the translation.                       |
-| `--glossary` | string  | Path to a glossary file to ensure consistent terminology across languages. Use `@path/to/glossary.md`. |
-
-### Usage Examples
-
-**Start an interactive translation session:**
-
-```bash
-aigne doc translate
-```
-
-**Translate specific documents into Chinese and Japanese:**
-
-```bash
-aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation --docs /overview
-```
-
-**Translate with a glossary and feedback for improved quality:**
-
-```bash
-aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently"
-```
-
----
-
-## `aigne doc publish`
-
-Publishes your documentation and generates a shareable link. This command uploads your content to a Discuss Kit instance. You can use the official AIGNE DocSmith platform or run your own instance of [Discuss Kit](https://www.web3kit.rocks/discuss-kit).
-
-![Screenshot of the publish command running.](../assets/screenshots/doc-publish.png)
-
-### Options
-
-| Option   | Type   | Description                                                                                             |
-| :------- | :----- | :------------------------------------------------------------------------------------------------------ |
-| `--appUrl` | string | The URL of your self-hosted Discuss Kit instance. If not provided, the command runs interactively. |
-
-### Usage Examples
-
-**Start an interactive publishing session:**
-
-```bash
-aigne doc publish
-```
-
-**Publish directly to a self-hosted instance:**
-
-```bash
-aigne doc publish --appUrl https://your-discuss-kit-instance.com
-```
-
----
-
-## `aigne doc prefs`
-
-Manages user preferences and feedback-driven rules. Over time, DocSmith learns from your feedback and creates persistent preferences. This command allows you to view, toggle, or remove these learned rules.
-
-### Options
-
-| Option   | Type    | Description                                                                |
-| :------- | :------ | :------------------------------------------------------------------------- |
-| `--list`   | boolean | Lists all saved preferences.                                               |
-| `--remove` | boolean | Interactively prompts to select and remove one or more preferences.        |
-| `--toggle` | boolean | Interactively prompts to select and toggle the active state of preferences. |
-| `--id`     | array   | Specifies one or more preference IDs to remove or toggle directly.         |
-
-### Usage Examples
-
-**List all saved preferences:**
-
-```bash
-aigne doc prefs --list
-```
-
-**Start interactive removal mode:**
-
-```bash
-aigne doc prefs --remove
-```
-
-**Toggle a specific preference by ID:**
-
-```bash
-aigne doc prefs --toggle --id "pref_2a1dfe2b09695aab"
-```
-
----
-
-## `aigne doc clear`
-
-Launches an interactive session to clear locally stored data. This can be used to remove the generated documentation, the document structure configuration, or cached authentication tokens.
-
-### Usage Example
-
-**Start the interactive cleanup process:**
-
-```bash
-aigne doc clear
-```