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

package/docs/guides-evaluating-documents.ja.md

@@ -1,66 +0,0 @@
-# ドキュメントの評価
-
-`evaluate` コマンドは、生成されたドキュメントの品質と整合性を評価するための体系的なプロセスを提供します。初期設定で定義した目標に対して、ドキュメント全体の構造と個々のドキュメントの内容の両方を分析します。このプロセスにより詳細なレポートが生成され、改善点を特定し、ドキュメントが意図した目的と対象読者に効果的に役立つことを確認するのに役立ちます。
-
-## 仕組み
-
-評価プロセスは、主に2つの段階で動作します。まず、高レベルのドキュメント構造を評価し、次に、個々のドキュメントの内容を分析します。
-
-1.  **構造評価**: このツールは、ドキュメント全体の構成（目次など）を検査します。選択したドキュメントの目標、対象読者、および内容の深さに基づいて、構造が論理的で完全であるかどうかを検証します。
-2.  **内容評価**: 構造を分析した後、ツールは各ドキュメントの内容を検査します。読みやすさ、一貫性、正確性など、いくつかの品質次元に対してドキュメントをスコアリングします。また、コード例が正しく実装されているかもチェックします。
-
-完了すると、ツールは結果をユーザーフレンドリーなHTMLレポートにまとめ、高レベルのスコアと詳細で実行可能なフィードバックの両方を提供します。
-
-## 評価の実行
-
-評価プロセスを開始するには、ターミナルで次のコマンドを実行します。
-
-```bash
-aignite evaluate
-```
-
-コマンドは、ドキュメントを分析する際の進捗状況を表示します。完了すると、生成されたレポートファイルの場所を示すメッセージが表示されます。
-
-```text
-✔ Generate evaluation report
-Evaluation report generated successfully.
-- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
-- HTML Report: .aigc/evaluate/20231027103000/report.html
-```
-
-Webブラウザで `report.html` ファイルを開くと、詳細な分析を表示できます。
-
-## レポートの理解
-
-評価レポートは、分析プロセスの2つの段階を反映して、2つの主要なセクションに分かれています。
-
-### 構造評価
-
-このセクションでは、ドキュメント全体のアーキテクチャに関するフィードバックを提供します。生成されたドキュメント階層が、指定した設定とどれだけ整合しているかを測定します。
-
-| ディメンション | 説明 |
-| :--- | :--- |
-| **目的カバレッジ** | ドキュメント構造が、選択した主要な目標（例：「すぐに始める」）を効果的にサポートしているかを評価します。 |
-| **対象読者カバレッジ** | 構造が、定義した対象読者（例：「非技術系ユーザー」）に対して適切であるかを判断します。 |
-| **深度カバレッジ** | 構造の詳細レベルが、選択した内容の深さ（例：「すべてのパラメータをカバー」）と一致しているかを確認します。 |
-
-### ドキュメント内容の評価
-
-このセクションでは、内容の品質をドキュメントごとに分析します。各ドキュメントは、一連の標準化された基準に基づいてスコアリングされます。
-
-| ディメンション | 説明 |
-| :--- | :--- |
-| **読みやすさ** | テキストがどれだけ読みやすく、理解しやすいかを測定します。 |
-| **整合性** | ドキュメント内の情報の論理的な流れと構成を評価します。 |
-| **内容の品質** | 提示された情報の正確性、関連性、明確さを評価します。 |
-| **統一性** | ドキュメント全体で用語、フォーマット、スタイルが統一されているかを確認します。 |
-| **目的との整合性** | 内容が指定されたドキュメントの目標をどれだけ満たしているかを判断します。 |
-| **対象読者との整合性** | 言語と例が対象読者に適しているかを評価します。 |
-| **知識レベルとの整合性** | 内容の複雑さが、定義された読者の知識レベルと一致しているかを確認します。 |
-| **ナビゲーション性** | ユーザーが情報を見つけるのに役立つ内部リンクや構造要素の有効性を評価します。 |
-
-## まとめ
-
-`evaluate` コマンドの使用は、正確で効果的なドキュメントを維持するための重要なステップです。具体的な指標と特定のフィードバックを提供し、内容を体系的に改善することができます。評価レポートを確認した後、的を絞った改善を進めることができます。
-
-このフィードバックに基づいてドキュメントを修正する次のステップについては、[ドキュメントの更新](./guides-updating-documentation.md)のガイドを参照してください。

package/docs/guides-evaluating-documents.md

@@ -1,107 +0,0 @@
-# Evaluating Documents
-
-The `evaluate` command provides a systematic method to assess the quality and completeness of your generated documentation. It analyzes both the overall document structure and the content of individual files against the criteria defined during project setup. The process concludes by generating a detailed report, which helps identify areas for improvement and ensures the documentation aligns with its intended purpose and audience.
-
-## The Evaluation Process
-
-The evaluation command executes a two-stage analysis to provide a comprehensive assessment of your documentation.
-
-```d2
-direction: down
-
-start: {
-  label: "Run Command\naignite evaluate"
-  shape: oval
-}
-
-structure-eval: {
-  label: "Stage 1: Evaluate\nDocument Structure"
-  shape: rectangle
-}
-
-content-eval: {
-  label: "Stage 2: Evaluate\nDocument Content"
-  shape: rectangle
-}
-
-report-gen: {
-  label: "Generate Report"
-  shape: rectangle
-}
-
-output: {
-  label: "Output HTML &\nJSON Report Files"
-  shape: oval
-}
-
-start -> structure-eval: "Analyzes overall organization"
-structure-eval -> content-eval: "Analyzes each file individually"
-content-eval -> report-gen: "Aggregates all findings"
-report-gen -> output: "Saves report to disk"
-```
-
-1.  **Structure Evaluation**: The tool first examines the documentation's high-level organization, analogous to a table of contents. It verifies whether the structure is logical and complete based on the specified documentation goals, target audience, and content depth.
-2.  **Content Evaluation**: Following the structural analysis, the tool inspects the content of each document. It scores each file against several quality dimensions, including readability, coherence, and factual accuracy. It also validates the correctness and formatting of included code snippets.
-
-The findings from both stages are compiled into an HTML report that presents high-level scores and specific, actionable feedback.
-
-## How to Run an Evaluation
-
-To initiate the evaluation process, execute the `evaluate` command from your project's root directory.
-
-### Execute the Command
-
-Open your terminal and run the following command:
-
-```bash
-aignite evaluate
-```
-
-The tool will display its progress as it analyzes the documentation.
-
-### Review the Output
-
-Upon completion, a confirmation message will appear in the terminal, specifying the location of the generated report files.
-
-```text
-✔ Generate evaluation report
-Evaluation report generated successfully.
-- JSON Report: .aigc/evaluate/20240520114500/integrity-report.json
-- HTML Report: .aigc/evaluate/20240520114500/report.html
-```
-
-Open the `report.html` file in a web browser to view the detailed analysis.
-
-## Understanding the Evaluation Report
-
-The report is organized into sections that correspond to the stages of the evaluation process, providing a clear breakdown of the analysis.
-
-### Structure Evaluation Details
-
-This section presents feedback on the overall architecture of your documentation. It measures how effectively the document hierarchy aligns with the project's configuration.
-
-| Dimension | Description |
-| :--- | :--- |
-| **Purpose Coverage** | Assesses if the document structure adequately supports the primary goals selected (e.g., "Get started quickly"). |
-| **Audience Coverage** | Determines if the structure is organized in a way that is suitable for the defined target audience (e.g., "non-technical users"). |
-| **Depth Coverage** | Checks if the level of detail implied by the structure matches the selected content depth (e.g., "covers all parameters"). |
-
-### Document Content Evaluation Details
-
-This section provides a file-by-file breakdown of content quality. Each document is scored based on a set of standardized criteria.
-
-| Dimension | Description |
-| :--- | :--- |
-| **Readability** | Measures the ease with which the text can be read and understood. |
-| **Coherence** | Evaluates the logical flow and organization of information within the document. |
-| **Content Quality** | Assesses the accuracy, relevance, and clarity of the information presented. |
-| **Consistency** | Checks for uniform terminology, formatting, and style throughout the document. |
-| **Purpose Alignment** | Determines how well the content fulfills the specified documentation goals. |
-| **Audience Alignment** | Assesses if the language, tone, and examples are appropriate for the target audience. |
-| **Knowledge Level Alignment** | Checks if the content's complexity matches the defined reader knowledge level. |
-
-## Summary
-
-Using the `evaluate` command is an essential step for maintaining accurate and effective documentation. It provides objective metrics and specific feedback, enabling a methodical approach to refining your content. After reviewing the evaluation report, you can make targeted improvements to enhance documentation quality.
-
-For guidance on modifying your documents based on this feedback, refer to the [Updating Documentation](./guides-updating-documentation.md) guide.

package/docs/guides-evaluating-documents.zh-TW.md

@@ -1,66 +0,0 @@
-# 評估文件
-
-`evaluate` 指令提供了一個系統化的流程，用以評估您所產生的文件的品質與契合度。它會根據您在初始設定中定義的目標，分析整體結構以及個別文件的內容。此流程會產出一份詳細的報告，幫助您找出需要改進的地方，並確保文件能有效地服務其預期目的和讀者。
-
-## 運作方式
-
-評估流程主要分為兩個階段。首先，它會評估高層次的文件結構；其次，它會分析每份個別文件的內容。
-
-1.  **結構評估**：該工具會檢查您文件的整體組織（例如目錄）。它會根據您所選的文件目標、目標讀者和內容深度，驗證結構是否合乎邏輯且完整。
-2.  **內容評估**：分析完結構後，該工具會檢視每份文件的內容。它會根據多個品質維度（包括可讀性、連貫性和準確性）對文件進行評分。它還會檢查程式碼範例的實作是否正確。
-
-完成後，該工具會將結果彙編成一份易於使用的 HTML 報告，提供高層次的分數和詳細、可行的回饋。
-
-## 執行評估
-
-要啟動評估流程，請在您的終端機中執行以下指令：
-
-```bash
-aignite evaluate
-```
-
-該指令在分析您的文件時會顯示進度。完成後，它會提供一則訊息，指出所產生的報告檔案的位置。
-
-```text
-✔ Generate evaluation report
-Evaluation report generated successfully.
-- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
-- HTML Report: .aigc/evaluate/20231027103000/report.html
-```
-
-您可以在網頁瀏覽器中開啟 `report.html` 檔案，以查看詳細的分析。
-
-## 理解報告
-
-評估報告分為兩個主要部分，對應分析流程的兩個階段。
-
-### 結構評估
-
-此部分提供關於您文件整體架構的回饋。它衡量所產生的文件層級結構與您指定的設定的契合程度。
-
-| 維度 | 說明 |
-| :--- | :--- |
-| **目的涵蓋率** | 評估文件結構是否有效地支援您所選的主要目標（例如，「快速入門」）。 |
-| **讀者涵蓋率** | 判斷結構是否適合您所定義的目標讀者（例如，「非技術使用者」）。 |
-| **深度涵蓋率** | 檢查結構中的細節層級是否與您所選的內容深度相符（例如，「涵蓋所有參數」）。 |
-
-### 文件內容評估
-
-此部分逐一分析各文件的內容品質。每份文件都會根據一組標準化準則進行評分。
-
-| 維度 | 說明 |
-| :--- | :--- |
-| **可讀性** | 衡量文字閱讀和理解的難易程度。 |
-| **連貫性** | 評估文件內資訊的邏輯流程與組織。 |
-| **內容品質** | 評估所呈現資訊的準確性、相關性和清晰度。 |
-| **一致性** | 檢查整份文件中的術語、格式和風格是否統一。 |
-| **目的契合度** | 判斷內容與指定文件目標的契合程度。 |
-| **讀者契合度** | 評估語言和範例是否適合目標讀者。 |
-| **知識水準契合度** | 檢查內容的複雜度是否與所定義的讀者知識水準相符。 |
-| **導覽性** | 評估內部連結和結構元素在幫助使用者尋找資訊方面的有效性。 |
-
-## 總結
-
-使用 `evaluate` 指令是維護準確且有效文件的關鍵步驟。它提供具體的指標和明確的回饋，讓您能有條不紊地完善您的內容。檢視評估報告後，您便可以著手進行針對性的改進。
-
-關於根據此回饋修改文件的後續步驟，請參閱 [更新文件](./guides-updating-documentation.md) 的指南。

package/docs/guides-evaluating-documents.zh.md

@@ -1,66 +0,0 @@
-# 评估文档
-
-`evaluate` 命令提供了一个系统化的流程，用于评估您生成的文档的质量和一致性。它会根据您在初始设置中定义的目标，分析文档的整体结构和单个文档的内容。此过程会生成一份详细的报告，帮助您识别需要改进的地方，并确保文档能够有效地服务于其预定目的和受众。
-
-## 工作原理
-
-评估过程分为两个主要阶段。首先，它评估高层级的文档结构；其次，它分析每个独立文档的内容。
-
-1.  **结构评估**：该工具会检查您文档的整体组织结构（例如目录）。它会根据您选择的文档目标、目标受众和内容深度，验证结构是否逻辑清晰且完整。
-2.  **内容评估**：在分析结构之后，该工具会检查每个文档的内容。它会根据可读性、连贯性和准确性等多个质量维度对文档进行评分。它还会检查代码示例的正确实现。
-
-完成后，该工具会将结果汇编成一份用户友好的 HTML 报告，提供高层级评分和详细、可操作的反馈。
-
-## 运行评估
-
-要启动评估过程，请在终端中执行以下命令：
-
-```bash
-aignite evaluate
-```
-
-该命令在分析您的文档时会显示进度。完成后，它将提供一条消息，指明生成的报告文件的位置。
-
-```text
-✔ Generate evaluation report
-Evaluation report generated successfully.
-- JSON Report: .aigc/evaluate/20231027103000/integrity-report.json
-- HTML Report: .aigc/evaluate/20231027103000/report.html
-```
-
-您可以在 Web 浏览器中打开 `report.html` 文件以查看详细分析。
-
-## 理解报告
-
-评估报告分为两个主要部分，对应分析过程的两个阶段。
-
-### 结构评估
-
-本节提供关于您文档整体架构的反馈。它衡量了生成的文档层次结构与您指定配置的对齐程度。
-
-| 维度 | 描述 |
-| :--- | :--- |
-| **目的覆盖率** | 评估文档结构是否有效支持您选择的主要目标（例如，“快速入门”）。 |
-| **受众覆盖率** | 判断结构是否适合您定义的目标受众（例如，“非技术用户”）。 |
-| **深度覆盖率** | 检查结构中的细节层次是否与您选择的内容深度相匹配（例如，“涵盖所有参数”）。 |
-
-### 文档内容评估
-
-本节按文档逐一分解内容质量。每个文档都根据一组标准化标准进行评分。
-
-| 维度 | 描述 |
-| :--- | :--- |
-| **可读性** | 衡量文本阅读和理解的难易程度。 |
-| **连贯性** | 评估文档内信息的逻辑流程和组织。 |
-| **内容质量** | 评估所呈现信息的准确性、相关性和清晰度。 |
-| **一致性** | 检查整个文档中术语、格式和风格的统一性。 |
-| **目的对齐** | 判断内容与指定的文档目标的契合程度。 |
-| **受众对齐** | 评估语言和示例是否适合目标受众。 |
-| **知识水平对齐** | 检查内容复杂度是否与定义的读者知识水平相匹配。 |
-| **导航性** | 评估内部链接和结构元素在帮助用户查找信息方面的有效性。 |
-
-## 总结
-
-使用 `evaluate` 命令是维护准确有效文档的关键步骤。它提供具体的指标和明确的反馈，让您能够有条不紊地优化内容。在审阅评估报告后，您可以着手进行有针对性的改进。
-
-关于根据此反馈修改文档的后续步骤，请参阅[更新文档](./guides-updating-documentation.md)指南。

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

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

package/docs/guides-generating-documentation.md

@@ -1,89 +0,0 @@
-# Generating Documentation
-
-This guide provides a step-by-step process for creating a new set of documentation for your project using the `generate` command. This is the primary command used to transform your source files into a structured set of documents from start to finish.
-
-The generation process is designed to be systematic and interactive, ensuring the final output meets your project's specific needs.
-
-## The Generation Process
-
-When you run `aigne doc generate`, the tool follows a methodical process to create your documentation. Here is a breakdown of each step.
-
-### Step 1: Initiate Generation
-
-To begin, navigate to your project's root directory in your terminal and execute the core command.
-
-```bash title="Terminal" icon=lucide:terminal
-aigne doc generate
-```
-
-This single command initiates the entire documentation creation workflow. If it's your first time running the command, you will be guided through an interactive setup process.
-
-![Generate Documentation Dialog](https://docsmith.aigne.io/image-bin/uploads/d409b85c2c7760778c18251e06d997d9.png)
-
-### Step 2: Code Analysis and Structure Planning
-
-First, DocSmith analyzes your source code to understand its structure, components, and relationships. Based on this analysis, it proposes an initial documentation structure. This plan organizes topics into a logical hierarchy, which may include sections like "Getting Started," "Guides," and "API Reference," tailored to your project's content.
-
-### Step 3: Interactive Structure Review
-
-After the initial structure is planned, you will be prompted to review it in the terminal. This is a critical step that allows you to refine the organization of your documents before the content is written.
-
-You can either approve the structure as is or provide feedback in plain language to make changes.
-
-![Reviewing the Documentation Structure](https://docsmith.aigne.io/image-bin/uploads/c530510525d8041c304d9c0258169904.png)
-
-Examples of feedback you can provide:
-
-*   Rename a section (e.g., change "Getting Started" to "Quick Start").
-*   Add a new document for "Troubleshooting."
-*   Remove a document that is not needed.
-*   Reorder sections to place "API Reference" before "Configuration."
-
-The tool will apply your feedback and present the updated structure for another review. You can repeat this process until the structure aligns perfectly with your requirements.
-
-### Step 4: Content Creation
-
-Once you approve the final structure, DocSmith proceeds to generate the detailed content for each document. It reads the relevant source files and writes clear explanations, code examples, and descriptions for every planned section. This process is executed for all documents in the approved plan.
-
-### Step 5: Completion
-
-When the process is complete, you will see a confirmation message indicating that the documentation has been generated successfully. The output files will be located in the directory specified in your configuration (the default is `./docs`).
-
-![Documentation Generated Successfully](https://docsmith.aigne.io/image-bin/uploads/19c72054cd662d51259e8f668571891e.png)
-
-## Command Options
-
-You can modify the behavior of the `generate` command by using optional flags. These flags provide more control over the generation process.
-
-| Option                | Description                                                                                                                                                               |
-| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--forceRegenerate`   | Re-creates all documentation from scratch, ignoring any existing files. This is useful if you have made significant changes to your source code or want a completely fresh build. |
-| `--glossary <path>`   | Specifies a glossary file (e.g., `--glossary @glossary.md`). This ensures that technical terms are defined and used consistently across all generated documents.               |
-
-### Example Usage
-
-Here are a few examples demonstrating how to use the command with its options.
-
-**Standard Generation**
-This is the most common use case for creating your initial set of documents.
-```bash title="Terminal" icon=lucide:terminal
-aigne doc generate
-```
-
-**Forced Regeneration**
-Use this command when you need to discard all existing documents and rebuild them entirely.
-```bash title="Terminal" icon=lucide:terminal
-aigne doc generate --forceRegenerate
-```
-
-**Using a Glossary**
-To ensure consistent terminology, provide a path to your glossary file.
-```bash title="Terminal" icon=lucide:terminal
-aigne doc generate --glossary @./glossary.md
-```
-
-## Summary
-
-You have now learned the complete process for generating documentation from your project's source files. This workflow involves initiating the command, interactively reviewing the proposed structure, and allowing the tool to write the content.
-
-After generating your documents, your next steps might be to [update specific documents](./guides-updating-documentation.md) with new information or [publish your documentation](./guides-publishing-your-docs.md) to make it accessible to your audience.