@aigne/doc-smith 0.8.11-beta.4 → 0.8.11-beta.6
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 +2 -4
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +17 -2
- package/README.md +1 -1
- package/agents/clear/choose-contents.mjs +2 -2
- package/agents/clear/clear-document-structure.mjs +8 -8
- package/agents/clear/index.yaml +1 -1
- package/agents/evaluate/document-structure.yaml +1 -1
- package/agents/generate/check-d2-diagram-valid.mjs +26 -0
- package/agents/generate/check-document-structure.yaml +3 -3
- package/agents/generate/check-need-generate-structure.mjs +8 -8
- package/agents/generate/document-structure-tools/add-document.mjs +3 -3
- package/agents/generate/document-structure-tools/delete-document.mjs +2 -2
- package/agents/generate/document-structure-tools/move-document.mjs +3 -2
- package/agents/generate/document-structure-tools/update-document.mjs +2 -2
- package/agents/generate/generate-d2-diagram.yaml +23 -0
- package/agents/generate/generate-structure.yaml +1 -1
- package/agents/generate/merge-d2-diagram.yaml +39 -0
- package/agents/generate/update-document-structure.yaml +3 -3
- package/agents/generate/user-review-document-structure.mjs +10 -10
- package/agents/init/index.mjs +18 -10
- package/agents/publish/publish-docs.mjs +17 -20
- package/agents/update/batch-generate-document.yaml +1 -1
- package/agents/update/check-document.mjs +2 -2
- package/agents/update/generate-document.yaml +25 -0
- package/agents/utils/check-feedback-refiner.mjs +1 -1
- package/agents/utils/choose-docs.mjs +1 -1
- package/agents/utils/load-document-all-content.mjs +3 -3
- package/agents/utils/load-sources.mjs +1 -1
- package/agents/utils/save-docs.mjs +7 -28
- package/aigne.yaml +2 -2
- package/docs/_sidebar.md +1 -1
- package/docs/advanced-how-it-works.md +3 -3
- package/docs/advanced-quality-assurance.md +1 -1
- package/docs/cli-reference.ja.md +151 -80
- package/docs/cli-reference.md +126 -55
- package/docs/cli-reference.zh-TW.md +133 -62
- package/docs/cli-reference.zh.md +143 -72
- package/docs/configuration-interactive-setup.md +1 -1
- package/docs/configuration-language-support.md +1 -1
- package/docs/configuration-preferences.md +1 -1
- package/docs/configuration.ja.md +104 -48
- package/docs/configuration.md +58 -2
- package/docs/configuration.zh-TW.md +99 -42
- package/docs/configuration.zh.md +78 -21
- package/docs/features-generate-documentation.ja.md +63 -44
- package/docs/features-generate-documentation.md +54 -35
- package/docs/features-generate-documentation.zh-TW.md +67 -48
- package/docs/features-generate-documentation.zh.md +61 -41
- package/docs/features-publish-your-docs.ja.md +69 -46
- package/docs/features-publish-your-docs.md +65 -42
- package/docs/features-publish-your-docs.zh-TW.md +73 -50
- package/docs/features-publish-your-docs.zh.md +67 -44
- package/docs/features-translate-documentation.ja.md +35 -33
- package/docs/features-translate-documentation.md +24 -22
- package/docs/features-translate-documentation.zh-TW.md +32 -30
- package/docs/features-translate-documentation.zh.md +29 -27
- package/docs/features-update-and-refine.ja.md +120 -66
- package/docs/features-update-and-refine.md +110 -56
- package/docs/features-update-and-refine.zh-TW.md +116 -62
- package/docs/features-update-and-refine.zh.md +118 -64
- package/docs/getting-started.ja.md +22 -22
- package/docs/getting-started.md +1 -1
- package/docs/getting-started.zh-TW.md +16 -16
- package/docs/getting-started.zh.md +28 -28
- package/docs/overview.md +3 -3
- package/docs-mcp/analyze-docs-relevance.yaml +6 -6
- package/docs-mcp/docs-search.yaml +1 -1
- package/package.json +3 -3
- package/prompts/common/document-structure/conflict-resolution-guidance.md +3 -3
- package/prompts/common/document-structure/document-structure-rules.md +2 -2
- package/prompts/detail/{d2-chart/rules.md → d2-diagram/rules-system.md} +41 -5
- package/prompts/detail/d2-diagram/rules-user.md +4 -0
- package/prompts/detail/document-rules.md +3 -4
- package/prompts/detail/generate-document.md +8 -2
- package/prompts/detail/update-document.md +0 -2
- package/prompts/evaluate/document-structure.md +6 -6
- package/prompts/structure/check-document-structure.md +10 -10
- package/prompts/structure/document-rules.md +2 -2
- package/prompts/structure/generate-structure-system.md +3 -3
- package/prompts/structure/structure-example.md +1 -1
- package/prompts/structure/structure-getting-started.md +1 -1
- package/prompts/structure/update-document-structure.md +9 -9
- package/prompts/utils/feedback-refiner.md +1 -1
- package/tests/agents/clear/choose-contents.test.mjs +1 -1
- package/tests/agents/clear/clear-document-structure.test.mjs +36 -30
- package/tests/agents/evaluate/generate-report.test.mjs +1 -1
- package/tests/agents/generate/check-need-generate-structure.test.mjs +1 -1
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +2 -2
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +4 -4
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +3 -3
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +3 -3
- package/tests/agents/generate/user-review-document-structure.test.mjs +7 -5
- package/tests/agents/init/init.test.mjs +25 -19
- package/tests/agents/publish/publish-docs.test.mjs +99 -0
- package/tests/agents/update/check-document.test.mjs +1 -1
- package/tests/agents/utils/check-detail-result.test.mjs +2 -15
- package/tests/agents/utils/format-document-structure.test.mjs +5 -5
- package/tests/agents/utils/load-sources.test.mjs +4 -4
- package/tests/agents/utils/save-docs.test.mjs +1 -1
- package/tests/utils/auth-utils.test.mjs +1 -1
- package/tests/utils/conflict-detector.test.mjs +1 -1
- package/tests/utils/d2-utils.test.mjs +4 -4
- package/tests/utils/deploy.test.mjs +3 -10
- package/tests/utils/docs-finder-utils.test.mjs +8 -8
- package/tests/utils/kroki-utils.test.mjs +5 -5
- package/tests/utils/preferences-utils.test.mjs +5 -3
- package/tests/utils/save-value-to-config.test.mjs +3 -1
- package/types/document-structure-schema.mjs +9 -9
- package/utils/auth-utils.mjs +4 -0
- package/utils/conflict-detector.mjs +1 -1
- package/utils/constants/index.mjs +7 -4
- package/utils/d2-utils.mjs +11 -6
- package/utils/deploy.mjs +4 -20
- package/utils/docs-finder-utils.mjs +11 -11
- package/utils/kroki-utils.mjs +5 -4
- package/utils/markdown-checker.mjs +1 -21
- /package/prompts/detail/{d2-chart → d2-diagram}/official-examples.md +0 -0
|
@@ -1,101 +1,120 @@
|
|
|
1
1
|
# 產生文件
|
|
2
2
|
|
|
3
|
-
`aigne doc generate`
|
|
3
|
+
`aigne doc generate` 指令是從您的原始碼建立一套完整文件的主要功能。此指令會啟動一個流程,分析您的程式碼庫、規劃一個合乎邏輯的文件結構,然後為每個部分產生內容。這是從初始狀態建立文件的標準方法。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 首次產生
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
首先,請導覽至您專案的根目錄並執行以下指令:
|
|
8
8
|
|
|
9
|
-
```bash
|
|
9
|
+
```bash aigne doc generate icon=lucide:play-circle
|
|
10
10
|
aigne doc generate
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
### 自動設定
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
如果您是首次在專案中執行此指令,DocSmith 會偵測到沒有任何設定存在。接著,它會自動啟動一個互動式設定精靈,引導您完成所需的設定步驟。此流程確保在產生開始前,已有一份有效的設定。
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
系統將提示您回答一系列問題,以定義您文件的關鍵面向,包括:
|
|
20
20
|
|
|
21
21
|
- 文件產生規則與風格
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
22
|
+
- 目標受眾
|
|
23
|
+
- 主要語言及任何額外的翻譯語言
|
|
24
|
+
- 原始碼輸入與文件輸出路徑
|
|
25
25
|
|
|
26
|
-

|
|
27
27
|
|
|
28
|
-
設定完成後,DocSmith
|
|
28
|
+
設定完成後,DocSmith 會繼續進行文件產生。
|
|
29
29
|
|
|
30
30
|

|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
成功完成後,新建立的文件將可在設定期間指定的輸出目錄中找到。
|
|
33
33
|
|
|
34
34
|

|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## 產生流程
|
|
37
37
|
|
|
38
|
-
`generate`
|
|
38
|
+
`generate` 指令會執行一個自動化的多步驟工作流程。流程概述如下:
|
|
39
39
|
|
|
40
40
|
```d2
|
|
41
41
|
direction: down
|
|
42
42
|
|
|
43
|
-
|
|
44
|
-
shape:
|
|
43
|
+
User: {
|
|
44
|
+
shape: c4-person
|
|
45
45
|
}
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
|
|
47
|
+
AIGNE-CLI: {
|
|
48
|
+
label: "AIGNE CLI"
|
|
49
49
|
}
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
Config-Check: {
|
|
52
|
+
label: "設定檔\n是否存在?"
|
|
52
53
|
shape: diamond
|
|
53
54
|
}
|
|
54
55
|
|
|
55
|
-
|
|
56
|
-
|
|
56
|
+
Setup-Wizard: {
|
|
57
|
+
label: "互動式\n設定精靈"
|
|
57
58
|
}
|
|
58
59
|
|
|
59
|
-
|
|
60
|
-
|
|
60
|
+
Generation-Process: {
|
|
61
|
+
label: "產生流程"
|
|
62
|
+
grid-columns: 1
|
|
63
|
+
|
|
64
|
+
Analyze: { label: "分析程式碼庫" }
|
|
65
|
+
Plan: { label: "規劃結構" }
|
|
66
|
+
Generate: { label: "產生內容" }
|
|
61
67
|
}
|
|
62
68
|
|
|
63
|
-
|
|
64
|
-
|
|
69
|
+
Source-Code: {
|
|
70
|
+
label: "原始碼"
|
|
71
|
+
shape: cylinder
|
|
65
72
|
}
|
|
66
73
|
|
|
67
|
-
|
|
68
|
-
|
|
74
|
+
Config-File: {
|
|
75
|
+
label: "config.yaml"
|
|
76
|
+
shape: cylinder
|
|
69
77
|
}
|
|
70
78
|
|
|
71
|
-
|
|
72
|
-
|
|
79
|
+
Output-Directory: {
|
|
80
|
+
label: "輸出目錄"
|
|
81
|
+
shape: cylinder
|
|
73
82
|
}
|
|
74
83
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
84
|
+
User -> AIGNE-CLI: "1. aigne doc generate"
|
|
85
|
+
AIGNE-CLI -> Config-Check: "2. 檢查設定檔"
|
|
86
|
+
|
|
87
|
+
Config-Check -> Setup-Wizard: "3a. 否"
|
|
88
|
+
Setup-Wizard -> User: "提示輸入"
|
|
89
|
+
User -> Setup-Wizard: "提供答案"
|
|
90
|
+
Setup-Wizard -> Config-File: "建立"
|
|
91
|
+
Config-File -> Generation-Process: "使用"
|
|
92
|
+
Setup-Wizard -> Generation-Process: "4. 繼續"
|
|
93
|
+
|
|
94
|
+
Config-Check -> Generation-Process: "3b. 是"
|
|
95
|
+
|
|
96
|
+
Source-Code -> Generation-Process.Analyze: "輸入"
|
|
97
|
+
Generation-Process.Analyze -> Generation-Process.Plan
|
|
98
|
+
Generation-Process.Plan -> Generation-Process.Generate
|
|
99
|
+
Generation-Process.Generate -> Output-Directory: "5. 寫入文件"
|
|
100
|
+
|
|
101
|
+
Output-Directory -> User: "6. 檢閱文件"
|
|
83
102
|
```
|
|
84
103
|
|
|
85
|
-
##
|
|
104
|
+
## 指令選項
|
|
86
105
|
|
|
87
|
-
|
|
106
|
+
預設的 `generate` 指令足以應對大多數使用情境。然而,有幾個選項可用於修改其行為,這在強制進行完整重新產生或改善文件結構時非常有用。
|
|
88
107
|
|
|
89
|
-
|
|
|
108
|
+
| 選項 | 說明 | 範例 |
|
|
90
109
|
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
|
|
91
|
-
| `--forceRegenerate` |
|
|
92
|
-
| `--feedback` |
|
|
93
|
-
| `--model` |
|
|
110
|
+
| `--forceRegenerate` | 刪除所有現有文件並從頭開始重新產生。在對原始碼或設定進行重大變更後使用此選項。 | `aigne doc generate --forceRegenerate` |
|
|
111
|
+
| `--feedback` | 提供高階回饋以改善整體文件結構,例如新增、移除或重組章節。 | `aigne doc generate --feedback "Add an API Reference section"` |
|
|
112
|
+
| `--model` | 指定使用 AIGNE Hub 中的特定大型語言模型來產生內容。這讓您可以在不同模型之間切換。 | `aigne doc generate --model anthropic:claude-3-5-sonnet` |
|
|
94
113
|
|
|
95
|
-
##
|
|
114
|
+
## 下一步是什麼?
|
|
96
115
|
|
|
97
|
-
|
|
116
|
+
產生初始文件後,您的專案將繼續發展。為了讓您的文件與程式碼保持同步,您需要執行更新。下一節將說明如何根據新需求或程式碼修改進行針對性變更並重新產生特定檔案。
|
|
98
117
|
|
|
99
|
-
<x-card data-title="
|
|
100
|
-
|
|
118
|
+
<x-card data-title="更新與改善" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
|
|
119
|
+
了解當您的程式碼變更時如何更新文件,或使用回饋進行特定改進。
|
|
101
120
|
</x-card>
|
|
@@ -1,101 +1,121 @@
|
|
|
1
1
|
# 生成文档
|
|
2
2
|
|
|
3
|
-
`aigne doc generate`
|
|
3
|
+
`aigne doc generate` 命令是用于从源代码创建完整文档集的主要功能。该命令会启动一个流程,分析您的代码库,规划逻辑化的文档结构,然后为每个部分生成内容。这是从初始状态创建文档的标准方法。
|
|
4
4
|
|
|
5
5
|
## 首次生成
|
|
6
6
|
|
|
7
7
|
首先,请导航到您项目的根目录并运行以下命令:
|
|
8
8
|
|
|
9
|
-
```bash
|
|
9
|
+
```bash aigne doc generate icon=lucide:play-circle
|
|
10
10
|
aigne doc generate
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
### 自动配置
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
如果您是首次在项目中运行此命令,DocSmith 会检测到尚无配置。然后,它会自动启动一个交互式设置向导,引导您完成所需的设置步骤。此过程可确保在生成开始前已存在有效的配置。
|
|
16
16
|
|
|
17
17
|

|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
系统将提示您回答一系列问题,以定义文档的关键方面,包括:
|
|
20
20
|
|
|
21
21
|
- 文档生成规则和风格
|
|
22
22
|
- 目标受众
|
|
23
|
-
-
|
|
24
|
-
-
|
|
23
|
+
- 主要语言和任何其他翻译语言
|
|
24
|
+
- 源代码输入和文档输出路径
|
|
25
25
|
|
|
26
|
-

|
|
27
27
|
|
|
28
|
-
配置完成后,DocSmith
|
|
28
|
+
配置完成后,DocSmith 会继续进行文档生成。
|
|
29
29
|
|
|
30
|
-

|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
成功完成后,新创建的文档将位于设置期间指定的输出目录中。
|
|
33
33
|
|
|
34
34
|

|
|
35
35
|
|
|
36
36
|
## 生成过程
|
|
37
37
|
|
|
38
|
-
`generate`
|
|
38
|
+
`generate` 命令执行一个自动化的多步骤工作流。流程概述如下:
|
|
39
39
|
|
|
40
40
|
```d2
|
|
41
41
|
direction: down
|
|
42
42
|
|
|
43
|
-
|
|
44
|
-
shape:
|
|
43
|
+
User: {
|
|
44
|
+
shape: c4-person
|
|
45
|
+
label: "用户"
|
|
45
46
|
}
|
|
46
47
|
|
|
47
|
-
|
|
48
|
-
|
|
48
|
+
AIGNE-CLI: {
|
|
49
|
+
label: "AIGNE CLI"
|
|
49
50
|
}
|
|
50
51
|
|
|
51
|
-
|
|
52
|
+
Config-Check: {
|
|
53
|
+
label: "配置\n存在?"
|
|
52
54
|
shape: diamond
|
|
53
55
|
}
|
|
54
56
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
+
Setup-Wizard: {
|
|
58
|
+
label: "交互式\n设置向导"
|
|
57
59
|
}
|
|
58
60
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
+
Generation-Process: {
|
|
62
|
+
label: "生成过程"
|
|
63
|
+
grid-columns: 1
|
|
64
|
+
|
|
65
|
+
Analyze: { label: "分析代码库" }
|
|
66
|
+
Plan: { label: "规划结构" }
|
|
67
|
+
Generate: { label: "生成内容" }
|
|
61
68
|
}
|
|
62
69
|
|
|
63
|
-
|
|
64
|
-
|
|
70
|
+
Source-Code: {
|
|
71
|
+
label: "源代码"
|
|
72
|
+
shape: cylinder
|
|
65
73
|
}
|
|
66
74
|
|
|
67
|
-
|
|
68
|
-
|
|
75
|
+
Config-File: {
|
|
76
|
+
label: "config.yaml"
|
|
77
|
+
shape: cylinder
|
|
69
78
|
}
|
|
70
79
|
|
|
71
|
-
|
|
72
|
-
|
|
80
|
+
Output-Directory: {
|
|
81
|
+
label: "输出目录"
|
|
82
|
+
shape: cylinder
|
|
73
83
|
}
|
|
74
84
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
85
|
+
User -> AIGNE-CLI: "1. aigne doc generate"
|
|
86
|
+
AIGNE-CLI -> Config-Check: "2. 检查配置"
|
|
87
|
+
|
|
88
|
+
Config-Check -> Setup-Wizard: "3a. 否"
|
|
89
|
+
Setup-Wizard -> User: "提示输入"
|
|
90
|
+
User -> Setup-Wizard: "提供回答"
|
|
91
|
+
Setup-Wizard -> Config-File: "创建"
|
|
92
|
+
Config-File -> Generation-Process: "使用"
|
|
93
|
+
Setup-Wizard -> Generation-Process: "4. 继续"
|
|
94
|
+
|
|
95
|
+
Config-Check -> Generation-Process: "3b. 是"
|
|
96
|
+
|
|
97
|
+
Source-Code -> Generation-Process.Analyze: "输入"
|
|
98
|
+
Generation-Process.Analyze -> Generation-Process.Plan
|
|
99
|
+
Generation-Process.Plan -> Generation-Process.Generate
|
|
100
|
+
Generation-Process.Generate -> Output-Directory: "5. 写入文档"
|
|
101
|
+
|
|
102
|
+
Output-Directory -> User: "6. 审阅文档"
|
|
83
103
|
```
|
|
84
104
|
|
|
85
105
|
## 命令选项
|
|
86
106
|
|
|
87
|
-
|
|
107
|
+
默认的 `generate` 命令足以满足大多数使用场景。然而,有几个选项可用于修改其行为,这对于强制完全重新生成或优化文档结构非常有用。
|
|
88
108
|
|
|
89
|
-
| 选项
|
|
109
|
+
| 选项 | 说明 | 示例 |
|
|
90
110
|
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
|
|
91
|
-
| `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。 | `aigne doc generate --forceRegenerate`
|
|
92
|
-
| `--feedback`
|
|
93
|
-
| `--model`
|
|
111
|
+
| `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。 | `aigne doc generate --forceRegenerate` |
|
|
112
|
+
| `--feedback` | 提供高层反馈以优化整体文档结构,例如添加、删除或重组部分。 | `aigne doc generate --feedback "Add an API Reference section"` |
|
|
113
|
+
| `--model` | 指定 AIGNE Hub 中的特定大型语言模型用于内容生成。这允许您在不同模型之间切换。 | `aigne doc generate --model anthropic:claude-3-5-sonnet` |
|
|
94
114
|
|
|
95
115
|
## 接下来做什么?
|
|
96
116
|
|
|
97
|
-
|
|
117
|
+
生成初始文档后,您的项目将继续演进。为了使文档与代码保持同步,您需要执行更新。下一节将解释如何根据新需求或代码修改进行有针对性的更改并重新生成特定文件。
|
|
98
118
|
|
|
99
119
|
<x-card data-title="更新和优化" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
|
|
100
|
-
|
|
120
|
+
了解当代码更改时如何更新文档,或使用反馈进行特定改进。
|
|
101
121
|
</x-card>
|
|
@@ -1,78 +1,101 @@
|
|
|
1
1
|
# ドキュメントを公開する
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ドキュメントを生成した後、 `aigne doc publish` コマンドはファイルをアップロードし、共有可能なリンク経由でアクセスできるようにします。このガイドでは、公式のAIGNEプラットフォームまたはセルフホストインスタンスにドキュメントを公開するためのステップバイステップのプロセスを提供します。
|
|
4
4
|
|
|
5
5
|
## 公開プロセス
|
|
6
6
|
|
|
7
|
-
`aigne doc publish
|
|
7
|
+
`aigne doc publish` コマンドは、インタラクティブなワークフローを開始します。初めて宛先に公開する際、CLIはブラウザを開き、1回限りの認証プロセスを案内します。その後の公開では、 `~/.aigne/doc-smith-connected.yaml` に保存されている認証情報が使用されます。
|
|
8
8
|
|
|
9
|
-
```d2
|
|
10
|
-
direction: down
|
|
9
|
+
```d2 公開ワークフロー icon=lucide:upload-cloud
|
|
11
10
|
shape: sequence_diagram
|
|
12
11
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
プラットフォーム: { label: "Discuss Kit プラットフォーム" }
|
|
17
|
-
|
|
18
|
-
ユーザー -> CLI: "aigne doc publish"
|
|
19
|
-
|
|
20
|
-
alt: "初回公開または設定がない場合" {
|
|
21
|
-
CLI -> ユーザー: "プラットフォームを選択\n(公式 / 自己ホスト型)"
|
|
22
|
-
ユーザー -> CLI: "選択を提供"
|
|
23
|
-
CLI -> ブラウザ: "認証URLを開く"
|
|
24
|
-
ユーザー -> ブラウザ: "ログインして承認"
|
|
25
|
-
ブラウザ -> プラットフォーム: "認証情報を送信"
|
|
26
|
-
プラットフォーム -> CLI: "アクセストークンを返す"
|
|
27
|
-
CLI -> CLI: "今後の使用のためにトークンを保存"
|
|
12
|
+
User: {
|
|
13
|
+
label: "開発者 / CI-CD"
|
|
14
|
+
shape: c4-person
|
|
28
15
|
}
|
|
29
16
|
|
|
30
|
-
CLI
|
|
31
|
-
|
|
32
|
-
|
|
17
|
+
CLI: {
|
|
18
|
+
label: "CLI\n(aigne doc publish)"
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
Local-Config: {
|
|
22
|
+
label: "ローカル設定\n(~/.aigne/...)"
|
|
23
|
+
shape: cylinder
|
|
24
|
+
}
|
|
33
25
|
|
|
26
|
+
Browser
|
|
27
|
+
|
|
28
|
+
Platform: {
|
|
29
|
+
label: "プラットフォーム\n(公式またはセルフホスト)"
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
User -> CLI: "コマンド実行"
|
|
33
|
+
|
|
34
|
+
alt "インタラクティブモード" {
|
|
35
|
+
CLI -> Local-Config: "認証情報を確認"
|
|
36
|
+
opt "認証情報が見つからない(初回)" {
|
|
37
|
+
CLI -> User: "プラットフォーム選択を促す"
|
|
38
|
+
User -> CLI: "プラットフォーム選択済み"
|
|
39
|
+
CLI -> Browser: "認証URLを開く"
|
|
40
|
+
User -> Browser: "ログイン & 承認"
|
|
41
|
+
Browser -> Platform: "トークンを要求"
|
|
42
|
+
Platform -> Browser: "トークンを返す"
|
|
43
|
+
Browser -> CLI: "CLIにトークンを送信"
|
|
44
|
+
CLI -> Local-Config: "認証情報を保存"
|
|
45
|
+
}
|
|
46
|
+
CLI -> Platform: "ドキュメントをアップロード"
|
|
47
|
+
Platform -> CLI: "成功を確認"
|
|
48
|
+
CLI -> User: "成功メッセージを表示"
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
alt "CI/CDモード" {
|
|
52
|
+
note over CLI: "ENV VARからトークンを読み取る"
|
|
53
|
+
CLI -> Platform: "ドキュメントをアップロード"
|
|
54
|
+
Platform -> CLI: "成功を確認"
|
|
55
|
+
CLI -> User: "成功ステータスを返す"
|
|
56
|
+
}
|
|
34
57
|
```
|
|
35
58
|
|
|
36
59
|
## 公開オプション
|
|
37
60
|
|
|
38
|
-
|
|
61
|
+
ドキュメントをホストする主要な宛先として、2つの選択肢があります:
|
|
39
62
|
|
|
40
63
|
<x-cards data-columns="2">
|
|
41
64
|
<x-card data-title="公式プラットフォーム" data-icon="lucide:globe">
|
|
42
|
-
AIGNE
|
|
65
|
+
AIGNEが運営するサービスであるdocsmith.aigne.ioに公開します。これは、オープンソースプロジェクトやドキュメントを迅速に公開共有するための簡単なオプションです。
|
|
43
66
|
</x-card>
|
|
44
|
-
<x-card data-title="
|
|
45
|
-
|
|
67
|
+
<x-card data-title="セルフホストインスタンス" data-icon="lucide:server">
|
|
68
|
+
ブランディング、アクセス、データプライバシーを完全に制御するために、独自のDiscuss Kitインスタンスに公開します。これは、内部またはプライベートなドキュメントに推奨されるオプションです。公式ドキュメントにある指示に従って、独自のDiscuss Kitインスタンスを実行できます。
|
|
46
69
|
</x-card>
|
|
47
70
|
</x-cards>
|
|
48
71
|
|
|
49
72
|
## ステップバイステップガイド
|
|
50
73
|
|
|
51
|
-
|
|
74
|
+
以下の手順に従ってドキュメントを公開してください。
|
|
52
75
|
|
|
53
|
-
### 1.
|
|
76
|
+
### 1. 公開コマンドの実行
|
|
54
77
|
|
|
55
|
-
|
|
78
|
+
プロジェクトのルートディレクトリに移動し、次のコマンドを実行します:
|
|
56
79
|
|
|
57
|
-
```bash
|
|
80
|
+
```bash ターミナル icon=lucide:terminal
|
|
58
81
|
aigne doc publish
|
|
59
82
|
```
|
|
60
83
|
|
|
61
|
-
### 2.
|
|
84
|
+
### 2. プラットフォームの選択
|
|
62
85
|
|
|
63
|
-
|
|
86
|
+
初めて公開する場合、宛先を選択するよう求められます。要件に合ったオプションを選択してください。
|
|
64
87
|
|
|
65
|
-

|
|
66
89
|
|
|
67
|
-
|
|
90
|
+
セルフホストインスタンスを選択した場合は、そのURLを入力するよう求められます。
|
|
68
91
|
|
|
69
|
-
### 3.
|
|
92
|
+
### 3. アカウントの認証
|
|
70
93
|
|
|
71
|
-
|
|
94
|
+
初回接続時には、ブラウザウィンドウが自動的に開き、ログインしてCLIを承認します。この手順はプラットフォームごとに1回だけ必要です。アクセストークンは、将来の使用のためにローカルに保存されます。
|
|
72
95
|
|
|
73
96
|
### 4. 確認
|
|
74
97
|
|
|
75
|
-
|
|
98
|
+
アップロードが完了すると、ターミナルに成功メッセージが表示され、ドキュメントが公開されたことを確認します。
|
|
76
99
|
|
|
77
100
|
```
|
|
78
101
|
✅ ドキュメントが正常に公開されました!
|
|
@@ -80,28 +103,28 @@ aigne doc publish
|
|
|
80
103
|
|
|
81
104
|
## CI/CD環境での公開
|
|
82
105
|
|
|
83
|
-
|
|
106
|
+
CI/CDパイプラインなどの自動化されたワークフローで公開コマンドを使用するには、引数や環境変数を通じて必要な情報を提供することで、インタラクティブなプロンプトをバイパスできます。
|
|
84
107
|
|
|
85
108
|
| 方法 | 名前 | 説明 |
|
|
86
109
|
|---|---|---|
|
|
87
|
-
| **引数** | `--appUrl` | Discuss KitインスタンスのURL
|
|
88
|
-
| **環境変数** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` |
|
|
110
|
+
| **引数** | `--appUrl` | Discuss KitインスタンスのURLを指定します。 |
|
|
111
|
+
| **環境変数** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | インタラクティブなログインプロセスをスキップするためのアクセストークンを提供します。 |
|
|
89
112
|
|
|
90
|
-
以下は、CI/CD
|
|
113
|
+
以下は、CI/CDスクリプトに適した非インタラクティブな公開コマンドの例です:
|
|
91
114
|
|
|
92
|
-
```bash CI/CD
|
|
115
|
+
```bash CI/CDの例 icon=lucide:workflow
|
|
93
116
|
export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
|
|
94
117
|
aigne doc publish --appUrl https://docs.mycompany.com
|
|
95
118
|
```
|
|
96
119
|
|
|
97
120
|
## トラブルシューティング
|
|
98
121
|
|
|
99
|
-
|
|
122
|
+
公開プロセス中に問題が発生した場合、以下の一般的な問題のいずれかが原因である可能性があります。
|
|
100
123
|
|
|
101
|
-
- **接続エラー**:
|
|
124
|
+
- **接続エラー**: CLIが `Unable to connect to: <URL>` のようなエラーメッセージを返すことがあります。これは、ネットワークの問題、サーバーが一時的に利用できない、またはURLが正しくないことが原因である可能性があります。URLが正しく、サーバーに到達可能であることを確認してください。
|
|
102
125
|
|
|
103
|
-
- **無効なウェブサイトURL**:
|
|
126
|
+
- **無効なウェブサイトURL**: コマンドが `The provided URL is not a valid website on ArcBlock platform` というメッセージで失敗することがあります。宛先URLはArcBlockプラットフォーム上に構築されたウェブサイトでなければなりません。ドキュメントをホストするには、独自のDiscuss Kitインスタンスを実行できます。
|
|
104
127
|
|
|
105
|
-
- **必須コンポーネントの欠落**:
|
|
128
|
+
- **必須コンポーネントの欠落**: `This website does not have required components for publishing` というエラーは、宛先のウェブサイトにDiscuss Kitコンポーネントがインストールされていないことを示します。サイトに必要なコンポーネントを追加するには、Discuss Kitのドキュメントを参照してください。
|
|
106
129
|
|
|
107
130
|
コマンドとオプションの完全なリストについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。
|