@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.
- package/.aigne/doc-smith/config.yaml +1 -1
- package/.aigne/doc-smith/history.yaml +37 -0
- package/.aigne/doc-smith/media-description.yaml +91 -0
- package/.aigne/doc-smith/preferences.yml +12 -0
- package/.aigne/doc-smith/upload-cache.yaml +36 -69
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +24 -0
- package/agents/clear/choose-contents.mjs +14 -1
- package/agents/clear/clear-media-description.mjs +129 -0
- package/agents/clear/index.yaml +3 -1
- package/agents/evaluate/code-snippet.mjs +28 -24
- package/agents/evaluate/document-structure.yaml +0 -4
- package/agents/evaluate/document.yaml +1 -5
- package/agents/generate/index.yaml +1 -0
- package/agents/generate/update-document-structure.yaml +9 -3
- package/agents/history/view.mjs +5 -2
- package/agents/init/index.mjs +10 -0
- package/agents/media/batch-generate-media-description.yaml +44 -0
- package/agents/media/generate-media-description.yaml +47 -0
- package/agents/media/load-media-description.mjs +238 -0
- package/agents/update/generate-document.yaml +10 -4
- package/agents/update/index.yaml +1 -0
- package/agents/update/update-document-detail.yaml +9 -3
- package/agents/update/user-review-document.mjs +2 -1
- package/agents/utils/load-sources.mjs +103 -53
- package/aigne.yaml +6 -0
- package/assets/report-template/report.html +34 -34
- package/docs/configuration-initial-setup.md +74 -55
- package/docs/configuration.ja.md +59 -86
- package/docs/configuration.md +59 -86
- package/docs/configuration.zh-TW.md +59 -86
- package/docs/configuration.zh.md +59 -86
- package/docs/getting-started.ja.md +43 -24
- package/docs/getting-started.md +29 -10
- package/docs/getting-started.zh-TW.md +42 -23
- package/docs/getting-started.zh.md +39 -20
- package/docs/guides-cleaning-up.ja.md +16 -15
- package/docs/guides-cleaning-up.md +19 -17
- package/docs/guides-cleaning-up.zh-TW.md +16 -15
- package/docs/guides-cleaning-up.zh.md +12 -11
- package/docs/guides-evaluating-documents.md +70 -29
- package/docs/guides-generating-documentation.ja.md +34 -32
- package/docs/guides-generating-documentation.md +59 -119
- package/docs/guides-generating-documentation.zh-TW.md +34 -32
- package/docs/guides-generating-documentation.zh.md +30 -28
- package/docs/guides-interactive-chat.md +34 -26
- package/docs/guides-managing-history.ja.md +17 -20
- package/docs/guides-managing-history.md +19 -17
- package/docs/guides-managing-history.zh-TW.md +18 -21
- package/docs/guides-managing-history.zh.md +13 -16
- package/docs/guides-publishing-your-docs.md +40 -35
- package/docs/guides-translating-documentation.ja.md +17 -17
- package/docs/guides-translating-documentation.md +39 -34
- package/docs/guides-translating-documentation.zh-TW.md +21 -21
- package/docs/guides-translating-documentation.zh.md +18 -18
- package/docs/guides-updating-documentation.ja.md +35 -35
- package/docs/guides-updating-documentation.md +11 -9
- package/docs/guides-updating-documentation.zh-TW.md +27 -27
- package/docs/guides-updating-documentation.zh.md +26 -26
- package/docs/overview.ja.md +13 -13
- package/docs/overview.md +2 -2
- package/docs/overview.zh-TW.md +19 -19
- package/docs/overview.zh.md +16 -16
- package/docs/release-notes.md +60 -27
- package/package.json +2 -1
- package/prompts/common/afs/afs-tools-usage.md +5 -0
- package/prompts/common/afs/use-afs-instruction.md +1 -0
- package/prompts/detail/generate/system-prompt.md +0 -13
- package/prompts/detail/generate/user-prompt.md +7 -0
- package/prompts/detail/update/system-prompt.md +1 -2
- package/prompts/detail/update/user-prompt.md +7 -0
- package/prompts/evaluate/document-structure.md +6 -7
- package/prompts/evaluate/document.md +16 -25
- package/prompts/media/media-description/system-prompt.md +35 -0
- package/prompts/media/media-description/user-prompt.md +8 -0
- package/prompts/structure/generate/system-prompt.md +0 -19
- package/prompts/structure/generate/user-prompt.md +22 -1
- package/prompts/structure/update/system-prompt.md +0 -17
- package/prompts/structure/update/user-prompt.md +24 -0
- package/tests/agents/history/view.test.mjs +97 -0
- package/tests/utils/history-utils.test.mjs +125 -97
- package/utils/constants/index.mjs +0 -107
- package/utils/file-utils.mjs +42 -1
- package/utils/history-utils.mjs +3 -3
- package/agents/update/fs-tools/glob.mjs +0 -184
- package/agents/update/fs-tools/grep.mjs +0 -317
- package/agents/update/fs-tools/read-file.mjs +0 -309
- package/media.md +0 -19
- package/tests/agents/update/fs-tools/glob.test.mjs +0 -438
- package/tests/agents/update/fs-tools/grep.test.mjs +0 -279
- package/tests/agents/update/fs-tools/read-file.test.mjs +0 -549
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# 生成文档
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
本指南提供了从项目源文件创建一套完整文档的系统化流程。该流程通过 `aigne doc generate` 命令启动,该命令会分析你的代码库,提出一个逻辑结构,然后为每个文档编写内容。
|
|
4
4
|
|
|
5
5
|
该命令是初次创建文档的主要工具。如需在文档创建后进行修改,请参阅[更新文档](./guides-updating-documentation.md)指南。
|
|
6
6
|
|
|
7
7
|
### 生成工作流
|
|
8
8
|
|
|
9
|
-
`generate`
|
|
9
|
+
`generate` 命令会执行一系列自动化步骤来构建你的文档。该流程设计为交互式,允许你在内容写入前审查并批准建议的结构。
|
|
10
10
|
|
|
11
11
|
```d2
|
|
12
12
|
direction: down
|
|
@@ -29,7 +29,7 @@ check_config: {
|
|
|
29
29
|
interactive_setup: {
|
|
30
30
|
label: "引导进行交互式设置"
|
|
31
31
|
shape: rectangle
|
|
32
|
-
tooltip: "如果未找到 .aigne/doc-smith/config.yaml
|
|
32
|
+
tooltip: "如果未找到 .aigne/doc-smith/config.yaml,则会触发交互式设置。"
|
|
33
33
|
}
|
|
34
34
|
|
|
35
35
|
propose_structure: {
|
|
@@ -50,7 +50,7 @@ user_approve: {
|
|
|
50
50
|
provide_feedback: {
|
|
51
51
|
label: "提供反馈以优化结构"
|
|
52
52
|
shape: rectangle
|
|
53
|
-
tooltip: "
|
|
53
|
+
tooltip: "用户可以请求更改,例如重命名、添加或删除章节。"
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
generate_content: {
|
|
@@ -86,53 +86,55 @@ generate_content -> end
|
|
|
86
86
|
|
|
87
87
|
## 分步流程
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
要生成文档,请在终端中导航到项目的根目录,并按照以下步骤操作。
|
|
90
90
|
|
|
91
91
|
### 1. 运行生成命令
|
|
92
92
|
|
|
93
|
-
执行 `generate`
|
|
93
|
+
执行 `generate` 命令以开始此过程。该工具将首先分析你项目的文件和结构。
|
|
94
94
|
|
|
95
|
-
```bash
|
|
95
|
+
```bash 基本生成命令
|
|
96
96
|
aigne doc generate
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
为简洁起见,你也可以使用别名 `gen` 或 `g`。
|
|
100
100
|
|
|
101
101
|
### 2. 审查文档结构
|
|
102
102
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
系统将提示您审查此计划:
|
|
103
|
+
分析完成后,该工具将显示建议的文档结构并提示你进行审查:
|
|
106
104
|
|
|
107
105
|
```
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
是的,优化结构
|
|
106
|
+
你希望优化文档结构吗?
|
|
107
|
+
❯ 不,看起来不错
|
|
108
|
+
是的,优化结构(例如,将“入门指南”重命名为“快速入门”,将“API 参考”移至“配置”之前)
|
|
112
109
|
```
|
|
113
110
|
|
|
114
|
-
-
|
|
115
|
-
-
|
|
111
|
+
- **不,看起来不错**:选择此选项以批准建议的结构,并直接进入内容生成阶段。
|
|
112
|
+
- **是的,优化结构**:选择此选项以修改计划。该工具将在一个交互式循环中征求你的反馈。你可以用纯文本提供指令,例如:
|
|
113
|
+
- `添加一个新文档“故障排除”`
|
|
114
|
+
- `删除“旧版功能”文档`
|
|
115
|
+
- `将“安装”移动到结构顶部`
|
|
116
|
+
|
|
117
|
+
在每次反馈后,AI 将修订结构,你可以再次审查。不输入任何反馈直接按 Enter 键即可退出循环并批准最终结构。
|
|
116
118
|
|
|
117
119
|
### 3. 内容生成
|
|
118
120
|
|
|
119
|
-
|
|
121
|
+
文档结构一经批准,DocSmith 将开始为计划中的每个文档生成详细内容。此过程自动运行,其持续时间取决于项目的规模和复杂性。
|
|
120
122
|
|
|
121
|
-
|
|
123
|
+
完成后,生成的文件将保存到你在配置中指定的输出目录(例如 `./docs`)。
|
|
122
124
|
|
|
123
125
|
## 命令参数
|
|
124
126
|
|
|
125
|
-
`generate`
|
|
127
|
+
`generate` 命令接受几个可选参数以控制其行为。
|
|
126
128
|
|
|
127
129
|
| 参数 | 描述 | 示例 |
|
|
128
|
-
|
|
129
|
-
| `--forceRegenerate` |
|
|
130
|
-
| `--feedback` |
|
|
131
|
-
| `--glossary` |
|
|
130
|
+
|---|---|---|
|
|
131
|
+
| `--forceRegenerate` | 从头开始重建所有文档,忽略任何现有结构或内容。当你想要完全重置时,此选项非常有用。 | `aigne doc generate --forceRegenerate` |
|
|
132
|
+
| `--feedback` | 在交互式审查开始前,提供基于文本的初始指令,以在结构生成阶段指导 AI。 | `aigne doc generate --feedback "添加更多 API 示例"` |
|
|
133
|
+
| `--glossary` | 指定一个术语表文件(例如 `glossary.md`),以确保在整个文档中术语使用的一致性。 | `aigne doc generate --glossary @/path/to/glossary.md` |
|
|
132
134
|
|
|
133
135
|
### 示例:强制完全重建
|
|
134
136
|
|
|
135
|
-
|
|
137
|
+
如果你想丢弃所有先前生成的文档,并根据代码的当前状态创建一套新文档,请使用 `--forceRegenerate` 标志。
|
|
136
138
|
|
|
137
139
|
```bash 强制重新生成
|
|
138
140
|
aigne doc generate --forceRegenerate
|
|
@@ -142,8 +144,8 @@ aigne doc generate --forceRegenerate
|
|
|
142
144
|
|
|
143
145
|
`generate` 命令协调了创建初始项目文档的整个过程。它将自动代码分析与交互式审查过程相结合,以生成一套结构化且相关的文档。
|
|
144
146
|
|
|
145
|
-
|
|
147
|
+
文档生成后,你可能希望:
|
|
146
148
|
|
|
147
149
|
- [更新文档](./guides-updating-documentation.md):对特定文档进行更改。
|
|
148
|
-
- [翻译文档](./guides-translating-documentation.md)
|
|
149
|
-
- [
|
|
150
|
+
- [翻译文档](./guides-translating-documentation.md):将你的内容翻译成其他语言。
|
|
151
|
+
- [发布你的文档](./guides-publishing-your-docs.md):将你的文档在线发布。
|
|
@@ -1,85 +1,93 @@
|
|
|
1
1
|
# Interactive Chat
|
|
2
2
|
|
|
3
|
-
The interactive chat assistant provides a conversational interface
|
|
3
|
+
The interactive chat assistant provides a conversational command-line interface to manage all aspects of your documentation lifecycle. It interprets natural language instructions to execute commands for document generation, updates, translation, and publishing.
|
|
4
4
|
|
|
5
|
-
This approach
|
|
5
|
+
This guided approach removes the need to memorize individual commands and options, making it the recommended method for most documentation tasks.
|
|
6
6
|
|
|
7
7
|
## Starting the Chat Assistant
|
|
8
8
|
|
|
9
|
-
To begin an interactive session, run the `chat` command from your
|
|
9
|
+
To begin an interactive session, run the `chat` command from your project's root directory:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
aigndoc chat
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
This
|
|
15
|
+
This command launches the assistant and presents a prompt, ready to receive your instructions.
|
|
16
16
|
|
|
17
17
|
## Core Capabilities
|
|
18
18
|
|
|
19
|
-
The chat assistant is designed to handle the entire documentation lifecycle. Its primary functions
|
|
19
|
+
The chat assistant is designed to handle the entire documentation lifecycle. Its primary functions are based on a set of specialized skills that it can call upon based on your requests.
|
|
20
20
|
|
|
21
21
|
<x-cards data-columns="2">
|
|
22
22
|
<x-card data-title="Generate Documentation" data-icon="lucide:file-plus-2">
|
|
23
|
-
|
|
23
|
+
Creates a complete documentation structure and initial content by analyzing your project's source code.
|
|
24
24
|
</x-card>
|
|
25
25
|
<x-card data-title="Refine and Update" data-icon="lucide:edit">
|
|
26
|
-
|
|
26
|
+
Modifies specific documents or sections based on your feedback or changes in the source code.
|
|
27
27
|
</x-card>
|
|
28
28
|
<x-card data-title="Translate Content" data-icon="lucide:languages">
|
|
29
|
-
|
|
29
|
+
Translates existing documentation into multiple supported languages to reach a broader audience.
|
|
30
30
|
</x-card>
|
|
31
31
|
<x-card data-title="Publish and Manage" data-icon="lucide:upload-cloud">
|
|
32
|
-
|
|
32
|
+
Guides you through the process of publishing your documentation and managing team-based workflows.
|
|
33
33
|
</x-card>
|
|
34
34
|
</x-cards>
|
|
35
35
|
|
|
36
|
+
## How It Works
|
|
37
|
+
|
|
38
|
+
You can interact with the assistant in two ways:
|
|
39
|
+
|
|
40
|
+
1. **Natural Language**: State your goal in plain language. The assistant will identify the correct tool and guide you through the required steps. For example, you can type "update the getting started guide" or "I need to translate my docs into French."
|
|
41
|
+
2. **Direct Commands**: You can also type specific commands directly into the chat prompt to initiate a task, such as `generate` or `publish`.
|
|
42
|
+
|
|
36
43
|
## Available Commands
|
|
37
44
|
|
|
38
|
-
|
|
45
|
+
The assistant understands a set of core commands that correspond to its specialized skills. You can invoke these directly or describe a task that requires them.
|
|
39
46
|
|
|
40
47
|
| Command | Description |
|
|
41
48
|
| :--- | :--- |
|
|
42
|
-
| `generate` | Starts the process of creating a new documentation structure from source files. |
|
|
43
|
-
| `update` | Modifies existing documents based on code changes or
|
|
49
|
+
| `generate` | Starts the process of creating a new documentation structure from your source files. |
|
|
50
|
+
| `update` | Modifies existing documents based on code changes or specific feedback. |
|
|
44
51
|
| `translate` | Translates documents into one or more supported languages. |
|
|
45
52
|
| `publish` | Publishes your documentation to make it accessible online. |
|
|
46
53
|
| `init` | Guides you through creating an initial configuration file for the project. |
|
|
47
54
|
| `clear` | Removes generated files, configurations, and cached data. |
|
|
48
55
|
| `prefs` | Manages your saved preferences for document generation. |
|
|
49
56
|
| `evaluate` | Assesses the quality and completeness of your generated documentation. |
|
|
50
|
-
| `history` | Shows the history of updates made to your documentation. |
|
|
51
|
-
| `exit` | Ends the interactive chat session. |
|
|
57
|
+
| `history` | Shows the history of updates and changes made to your documentation. |
|
|
58
|
+
| `exit` | Ends the interactive chat session and returns you to the standard terminal prompt. |
|
|
52
59
|
|
|
53
60
|
## Example Interaction
|
|
54
61
|
|
|
55
|
-
|
|
62
|
+
The following is a sample conversation that illustrates a typical workflow for generating new documentation.
|
|
56
63
|
|
|
57
64
|
```text
|
|
58
65
|
You:
|
|
59
|
-
>
|
|
66
|
+
> I need to create documentation for my project located in the 'src' folder.
|
|
60
67
|
|
|
61
68
|
AI Assistant:
|
|
62
|
-
|
|
69
|
+
Understood. I will start the documentation generation process for the directory './src'.
|
|
70
|
+
First, I will analyze your project to propose a documentation structure. This may take a few moments...
|
|
71
|
+
...
|
|
72
|
+
Analysis complete. I have created a proposed structure. Would you like to review it before I generate the content? (yes/no)
|
|
63
73
|
|
|
64
74
|
You:
|
|
65
|
-
>
|
|
75
|
+
> yes
|
|
66
76
|
|
|
67
77
|
AI Assistant:
|
|
68
|
-
|
|
78
|
+
(The proposed documentation structure is displayed here for your review.)
|
|
69
79
|
...
|
|
70
|
-
|
|
80
|
+
You can request changes, such as 'add a guide for API authentication' or 'remove the section on deployment'. If the structure is correct, simply type 'continue'.
|
|
71
81
|
|
|
72
82
|
You:
|
|
73
|
-
>
|
|
83
|
+
> continue
|
|
74
84
|
|
|
75
85
|
AI Assistant:
|
|
76
|
-
|
|
77
|
-
...
|
|
78
|
-
Please review the structure above. You can ask me to add, remove, or modify any part of it.
|
|
86
|
+
Great. I will now proceed with generating the content for each document. This may take a few minutes.
|
|
79
87
|
```
|
|
80
88
|
|
|
81
89
|
## Summary
|
|
82
90
|
|
|
83
|
-
The interactive chat assistant
|
|
91
|
+
The interactive chat assistant provides a structured and guided method for managing your documentation. It consolidates the functionality of all individual commands into a single, conversational interface, ensuring a consistent and straightforward workflow.
|
|
84
92
|
|
|
85
|
-
For a
|
|
93
|
+
For a detailed walkthrough of creating your first set of documents using the assistant, please proceed to the [Generating Documentation](./guides-generating-documentation.md) guide.
|
|
@@ -1,51 +1,48 @@
|
|
|
1
1
|
# 履歴の管理
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmithは、ドキュメントに加えられたすべての更新の時系列ログを保持します。この機能により、変更を追跡し、更新時に提供されたフィードバックを確認し、時間とともにドキュメントがどのように変化したかを理解できます。このガイドでは、この履歴にアクセスして解釈する方法について説明します。
|
|
4
4
|
|
|
5
5
|
## 更新履歴の表示
|
|
6
6
|
|
|
7
|
-
すべてのドキュメント更新のログを表示するには、`history view` コマンドを使用します。このコマンドは、バージョン管理ログのように、各エントリの簡潔な1
|
|
7
|
+
すべてのドキュメント更新のログを表示するには、`history view` コマンドを使用します。このコマンドは、バージョン管理ログのように、各エントリの簡潔な1行の要約を表示します。
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
ターミナルで次のコマンドを実行してください:
|
|
10
10
|
|
|
11
11
|
```bash 履歴の表示 icon=material-symbols:history
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
`history` コマンドは、`view` サブコマンドの2つのエイリアス、`log` と `list`
|
|
15
|
+
`history` コマンドは、`view` サブコマンドの2つのエイリアス、`log` と `list` もサポートしています。以下のコマンドは同等であり、同じ出力を生成します:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
25
22
|
### 履歴出力の理解
|
|
26
23
|
|
|
27
|
-
`history view`
|
|
24
|
+
`history view` コマンドの出力は、各更新に関する主要な情報を一目でわかるようにフォーマットされています。各行は、1つの更新エントリを表します。
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
以下にそのフォーマットの内訳を示します:
|
|
30
27
|
|
|
31
28
|
| コンポーネント | 説明 |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
|
30
|
+
| **Short Hash** | 更新のタイムスタンプから生成される8文字の一意の識別子。 |
|
|
31
|
+
| **Date** | 更新が発生した時期を示す相対的なタイムスタンプ(例:「5 minutes ago」、「2 days ago」)。古いエントリには、特定の日付が表示されます。 |
|
|
32
|
+
| **Operation** | `generate_document` や `update_document_detail` など、実行されたアクションの種類。 |
|
|
33
|
+
| **Document Path** | 操作が単一ファイルを対象とした場合に、変更された特定のドキュメントのパス。これは括弧で囲まれます。 |
|
|
34
|
+
| **Feedback** | 更新が行われたときに提供されたフィードバックまたは要約メッセージ。 |
|
|
38
35
|
|
|
39
36
|
### 例
|
|
40
37
|
|
|
41
|
-
|
|
38
|
+
以下は `aigne history view` コマンドを実行した際のサンプル出力です。
|
|
42
39
|
|
|
43
40
|
```bash
|
|
44
|
-
📜
|
|
41
|
+
📜 Update History
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 hours ago update_document_detail (/guides/generating-documentation): Added a new section on advanced configuration options.
|
|
44
|
+
a3b1c9d2 1 day ago update_document_detail (/overview): Refined the introduction to be more concise.
|
|
45
|
+
f8d2e0c3 3 days ago generate_document (/guides/managing-history): Initial generation of the history management guide.
|
|
49
46
|
```
|
|
50
47
|
|
|
51
|
-
|
|
48
|
+
このログは、ドキュメントの変更履歴を明確かつ整理された記録として提供し、進捗の追跡や過去の変更の確認に役立ちます。
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# Managing History
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith maintains a chronological log of all updates made to your documentation. This feature allows you to track changes, review feedback provided
|
|
3
|
+
AIGNE DocSmith maintains a chronological log of all updates made to your documentation. This feature allows you to track changes, review the feedback provided for each update, and observe the evolution of your documents over time. This guide provides instructions on how to access and interpret this history log.
|
|
4
4
|
|
|
5
5
|
## Viewing Update History
|
|
6
6
|
|
|
7
|
-
To view the log of all documentation updates,
|
|
7
|
+
To view the log of all documentation updates, use the `history view` command. This command displays a compact, one-line summary for each entry, formatted similarly to a version control log.
|
|
8
8
|
|
|
9
|
-
Execute the following command in your
|
|
9
|
+
Execute the following command in your project's root directory:
|
|
10
10
|
|
|
11
11
|
```bash Viewing History icon=material-symbols:history
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
For convenience, the `history` command also supports two aliases for the `view` subcommand: `log` and `list`. The following commands are equivalent to the one above and will produce the identical output:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
@@ -22,30 +22,32 @@ aigne history log
|
|
|
22
22
|
aigne history list
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
+
If no updates have been made yet, the tool will display the message: `No update history found`.
|
|
26
|
+
|
|
25
27
|
### Understanding the History Output
|
|
26
28
|
|
|
27
|
-
The output of the `history view` command is
|
|
29
|
+
The output of the `history view` command is structured to provide key information about each update in a concise format. Each line in the log represents a single update event.
|
|
28
30
|
|
|
29
|
-
|
|
31
|
+
The format is composed of the following components:
|
|
30
32
|
|
|
31
33
|
| Component | Description |
|
|
32
34
|
| :--- | :--- |
|
|
33
|
-
| **Short Hash** |
|
|
34
|
-
| **Date** | A relative timestamp indicating when the update occurred (e.g., "5 minutes ago", "2 days ago"). For older
|
|
35
|
-
| **Operation** | The type of action performed, such as `
|
|
36
|
-
| **Document Path** | The path of the specific document that was modified, if the operation targeted a single file. This is enclosed in parentheses. |
|
|
37
|
-
| **Feedback** | The
|
|
35
|
+
| **Short Hash** | An 8-character unique identifier generated from the timestamp of the update. This hash is deterministic, meaning the same timestamp will always produce the same hash. |
|
|
36
|
+
| **Date** | A relative timestamp indicating when the update occurred (e.g., "5 minutes ago", "2 days ago"). For entries older than one week, a specific date is shown. |
|
|
37
|
+
| **Operation** | The type of action performed, such as `generate_document` or `update_document_detail`. |
|
|
38
|
+
| **Document Path** | The path of the specific document that was modified, if the operation targeted a single file. This is enclosed in parentheses for clarity. |
|
|
39
|
+
| **Feedback** | The summary message or feedback that was provided when the update was executed. |
|
|
38
40
|
|
|
39
|
-
### Example
|
|
41
|
+
### Example Output
|
|
40
42
|
|
|
41
|
-
Below is a sample output from running the `aigne history view` command.
|
|
43
|
+
Below is a sample output from running the `aigne history view` command. This example illustrates how different operations are recorded in the log.
|
|
42
44
|
|
|
43
45
|
```bash
|
|
44
46
|
📜 Update History
|
|
45
47
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
48
|
+
e5a4f8b1 2 hours ago update_document_detail (/guides/generating-documentation): Added a new section on advanced configuration options.
|
|
49
|
+
a3b1c9d2 1 day ago update_document_detail (/overview): Refined the introduction to be more concise.
|
|
50
|
+
f8d2e0c3 3 days ago generate_document (/guides/managing-history): Initial generation of the history management guide.
|
|
49
51
|
```
|
|
50
52
|
|
|
51
|
-
This log provides a clear and orderly record of your documentation's modification history, which is
|
|
53
|
+
This log provides a clear and orderly record of your documentation's modification history, which is an effective tool for tracking progress and reviewing past changes.
|
|
@@ -1,39 +1,36 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 管理歷史紀錄
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 會按時間順序記錄您對文件所做的所有更新。此功能可讓您追蹤變更、檢閱更新期間提供的回饋,並了解文件隨時間的演變過程。本指南將說明如何存取和解讀此歷史紀錄。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 查看更新歷史紀錄
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
若要查看所有文件的更新日誌,您可以使用 `history view` 指令。此指令會為每個項目顯示精簡的單行摘要,類似於版本控制的日誌。
|
|
8
8
|
|
|
9
9
|
在您的終端機中執行以下指令:
|
|
10
10
|
|
|
11
|
-
```bash
|
|
11
|
+
```bash 查看歷史紀錄 icon=material-symbols:history
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
`history` 指令也支援 `view` 子指令的兩個別名:`log` 和 `list
|
|
15
|
+
`history` 指令也支援 `view` 子指令的兩個別名:`log` 和 `list`。以下指令是等效的,將會產生相同的輸出:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
25
|
-
###
|
|
22
|
+
### 了解歷史紀錄輸出
|
|
26
23
|
|
|
27
|
-
`history view`
|
|
24
|
+
`history view` 指令的輸出格式旨在讓您能一目了然地獲取每次更新的關鍵資訊。每一行代表一個單獨的更新項目。
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
以下是其格式的詳細說明:
|
|
30
27
|
|
|
31
28
|
| 元件 | 說明 |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
|
|
|
34
|
-
| **日期** |
|
|
35
|
-
| **操作** | 執行的操作類型,例如 `
|
|
36
|
-
| **文件路徑** |
|
|
30
|
+
| **簡短雜湊值** | 一個從更新時間戳產生的 8 字元唯一識別碼。 |
|
|
31
|
+
| **日期** | 一個相對時間戳,表示更新發生的時間(例如,「5 分鐘前」、「2 天前」)。對於較舊的項目,則會顯示具體日期。 |
|
|
32
|
+
| **操作** | 執行的操作類型,例如 `generate_document` 或 `update_document_detail`。 |
|
|
33
|
+
| **文件路徑** | 如果操作針對的是單一檔案,則為被修改的特定文件的路徑。此路徑會用括號括起來。 |
|
|
37
34
|
| **回饋** | 進行更新時所提供的回饋或摘要訊息。 |
|
|
38
35
|
|
|
39
36
|
### 範例
|
|
@@ -41,11 +38,11 @@ aigne history list
|
|
|
41
38
|
以下是執行 `aigne history view` 指令的範例輸出。
|
|
42
39
|
|
|
43
40
|
```bash
|
|
44
|
-
📜
|
|
41
|
+
📜 更新歷史紀錄
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 小時前 update_document_detail (/guides/generating-documentation): 新增了關於進階設定選項的新章節。
|
|
44
|
+
a3b1c9d2 1 天前 update_document_detail (/overview): 修訂了簡介,使其更加簡潔。
|
|
45
|
+
f8d2e0c3 3 天前 generate_document (/guides/managing-history): 初次產生歷史紀錄管理指南。
|
|
49
46
|
```
|
|
50
47
|
|
|
51
|
-
|
|
48
|
+
此日誌提供了您文件修改歷史的清晰有序記錄,有助於追蹤進度和檢閱過去的變更。
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# 管理历史记录
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 会为您的文档所做的所有更新保留一份按时间顺序排列的日志。此功能允许您跟踪变更、审查更新期间提供的反馈,并了解文档随时间的演变过程。本指南说明了如何访问和解读此历史记录。
|
|
4
4
|
|
|
5
5
|
## 查看更新历史记录
|
|
6
6
|
|
|
7
|
-
要查看所有文档更新的日志,您可以使用 `history view`
|
|
7
|
+
要查看所有文档更新的日志,您可以使用 `history view` 命令。该命令会为每条记录显示一个紧凑的单行摘要,类似于版本控制日志。
|
|
8
8
|
|
|
9
9
|
在您的终端中执行以下命令:
|
|
10
10
|
|
|
@@ -12,29 +12,26 @@ AIGNE DocSmith 会按时间顺序记录对您文档所做的所有更新。此
|
|
|
12
12
|
aigne history view
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
`history` 命令还支持 `view` 子命令的两个别名:`log` 和 `list
|
|
15
|
+
`history` 命令还支持 `view` 子命令的两个别名:`log` 和 `list`。以下命令是等效的,并将产生相同的输出:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
19
|
aigne history list
|
|
23
20
|
```
|
|
24
21
|
|
|
25
22
|
### 理解历史记录输出
|
|
26
23
|
|
|
27
|
-
`history view`
|
|
24
|
+
`history view` 命令的输出经过格式化,以便一目了然地提供每次更新的关键信息。每一行代表一条更新记录。
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
以下是其格式的分解说明:
|
|
30
27
|
|
|
31
28
|
| 组件 | 描述 |
|
|
32
29
|
| :--- | :--- |
|
|
33
|
-
|
|
|
34
|
-
| **日期** |
|
|
35
|
-
| **操作** | 执行的操作类型,例如 `
|
|
36
|
-
| **文档路径** |
|
|
37
|
-
| **反馈** |
|
|
30
|
+
| **短哈希值** | 根据更新时间戳生成的 8 位字符唯一标识符。 |
|
|
31
|
+
| **日期** | 一个相对时间戳,表示更新发生的时间(例如,“5 分钟前”、“2 天前”)。对于较早的记录,会显示具体日期。 |
|
|
32
|
+
| **操作** | 执行的操作类型,例如 `generate_document` 或 `update_document_detail`。 |
|
|
33
|
+
| **文档路径** | 如果操作针对单个文件,则为被修改的具体文档的路径。该路径包含在括号中。 |
|
|
34
|
+
| **反馈** | 更新时提供的反馈或摘要信息。 |
|
|
38
35
|
|
|
39
36
|
### 示例
|
|
40
37
|
|
|
@@ -43,9 +40,9 @@ aigne history list
|
|
|
43
40
|
```bash
|
|
44
41
|
📜 更新历史记录
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
e5a4f8b1 2 hours ago update_document_detail (/guides/generating-documentation): Added a new section on advanced configuration options.
|
|
44
|
+
a3b1c9d2 1 day ago update_document_detail (/overview): Refined the introduction to be more concise.
|
|
45
|
+
f8d2e0c3 3 days ago generate_document (/guides/managing-history): Initial generation of the history management guide.
|
|
49
46
|
```
|
|
50
47
|
|
|
51
48
|
此日志为您的文档修改历史提供了清晰有序的记录,有助于跟踪进度和回顾过去的变更。
|