@aigne/doc-smith 0.8.11-beta → 0.8.11-beta.2
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 -0
- package/.aigne/doc-smith/output/structure-plan.json +3 -3
- package/.aigne/doc-smith/upload-cache.yaml +252 -0
- package/.github/workflows/publish-docs.yml +67 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +22 -0
- package/README.md +45 -115
- package/agents/clear/choose-contents.mjs +170 -0
- package/agents/clear/clear-auth-tokens.mjs +111 -0
- package/agents/clear/clear-document-config.mjs +39 -0
- package/agents/clear/clear-document-structure.mjs +106 -0
- package/agents/clear/clear-generated-docs.mjs +51 -0
- package/agents/clear/index.yaml +23 -0
- package/agents/evaluate/code-snippet.mjs +93 -0
- package/agents/evaluate/document-structure.yaml +70 -0
- package/agents/evaluate/document.yaml +79 -0
- package/agents/evaluate/generate-report.mjs +78 -0
- package/agents/evaluate/index.yaml +39 -0
- package/agents/generate/document-structure-tools/add-document.mjs +56 -0
- package/agents/generate/document-structure-tools/delete-document.mjs +49 -0
- package/agents/generate/document-structure-tools/move-document.mjs +82 -0
- package/agents/generate/document-structure-tools/update-document.mjs +50 -0
- package/agents/generate/generate-structure.yaml +1 -1
- package/agents/generate/update-document-structure.yaml +42 -0
- package/agents/generate/user-review-document-structure.mjs +6 -4
- package/agents/init/index.mjs +1 -1
- package/agents/publish/publish-docs.mjs +12 -3
- package/agents/translate/choose-language.mjs +1 -1
- package/agents/update/batch-update-document.yaml +7 -0
- package/agents/update/check-update-is-single.mjs +38 -0
- package/agents/update/document-tools/update-document-content.mjs +293 -0
- package/agents/update/index.yaml +4 -10
- package/agents/update/update-document-detail.yaml +52 -0
- package/agents/update/update-single-document.yaml +15 -0
- package/agents/update/user-review-document.mjs +248 -0
- package/agents/utils/choose-docs.mjs +4 -2
- package/agents/utils/format-document-structure.mjs +12 -2
- package/agents/utils/load-document-all-content.mjs +84 -0
- package/agents/utils/load-sources.mjs +4 -1
- package/aigne.yaml +59 -20
- package/assets/report-template/report.html +198 -0
- package/biome.json +14 -2
- package/docs/advanced-how-it-works.ja.md +101 -0
- package/docs/advanced-how-it-works.zh-TW.md +101 -0
- package/docs/advanced-how-it-works.zh.md +20 -20
- package/docs/advanced-quality-assurance.ja.md +96 -0
- package/docs/advanced-quality-assurance.zh-TW.md +96 -0
- package/docs/advanced-quality-assurance.zh.md +18 -18
- package/docs/advanced.ja.md +16 -0
- package/docs/advanced.zh-TW.md +16 -0
- package/docs/advanced.zh.md +4 -4
- package/docs/changelog.ja.md +309 -0
- package/docs/changelog.zh-TW.md +309 -0
- package/docs/changelog.zh.md +23 -23
- package/docs/cli-reference.ja.md +210 -0
- package/docs/cli-reference.zh-TW.md +210 -0
- package/docs/cli-reference.zh.md +21 -21
- package/docs/configuration-interactive-setup.ja.md +135 -0
- package/docs/configuration-interactive-setup.zh-TW.md +135 -0
- package/docs/configuration-interactive-setup.zh.md +29 -29
- package/docs/configuration-language-support.ja.md +94 -0
- package/docs/configuration-language-support.zh-TW.md +94 -0
- package/docs/configuration-language-support.zh.md +13 -13
- package/docs/configuration-llm-setup.ja.md +54 -0
- package/docs/configuration-llm-setup.zh-TW.md +54 -0
- package/docs/configuration-llm-setup.zh.md +12 -12
- package/docs/configuration-preferences.ja.md +129 -0
- package/docs/configuration-preferences.zh-TW.md +129 -0
- package/docs/configuration-preferences.zh.md +36 -36
- package/docs/configuration.ja.md +172 -0
- package/docs/configuration.zh-TW.md +172 -0
- package/docs/configuration.zh.md +49 -49
- package/docs/features-generate-documentation.ja.md +101 -0
- package/docs/features-generate-documentation.zh-TW.md +101 -0
- package/docs/features-generate-documentation.zh.md +17 -17
- package/docs/features-publish-your-docs.ja.md +107 -0
- package/docs/features-publish-your-docs.zh-TW.md +107 -0
- package/docs/features-publish-your-docs.zh.md +22 -22
- package/docs/features-translate-documentation.ja.md +79 -0
- package/docs/features-translate-documentation.zh-TW.md +79 -0
- package/docs/features-translate-documentation.zh.md +12 -12
- package/docs/features-update-and-refine.ja.md +138 -0
- package/docs/features-update-and-refine.zh-TW.md +138 -0
- package/docs/features-update-and-refine.zh.md +21 -21
- package/docs/features.ja.md +52 -0
- package/docs/features.zh-TW.md +52 -0
- package/docs/features.zh.md +8 -8
- package/docs/getting-started.ja.md +123 -0
- package/docs/getting-started.zh-TW.md +123 -0
- package/docs/getting-started.zh.md +24 -24
- package/docs/overview.ja.md +30 -0
- package/docs/overview.zh-TW.md +30 -0
- package/docs/overview.zh.md +8 -8
- package/package.json +19 -11
- package/prompts/common/document/content-rules-core.md +19 -0
- package/prompts/common/document/media-handling-rules.md +9 -0
- package/prompts/common/document/role-and-personality.md +15 -0
- package/prompts/common/document/user-preferences.md +9 -0
- package/prompts/common/document-structure/conflict-resolution-guidance.md +16 -0
- package/prompts/common/document-structure/document-structure-rules.md +45 -0
- package/prompts/common/document-structure/glossary.md +7 -0
- package/prompts/common/document-structure/intj-traits.md +5 -0
- package/prompts/common/document-structure/output-constraints.md +9 -0
- package/prompts/common/document-structure/user-locale-rules.md +10 -0
- package/prompts/common/document-structure/user-preferences.md +9 -0
- package/prompts/detail/custom/custom-components.md +9 -1
- package/prompts/detail/document-rules.md +6 -6
- package/prompts/detail/generate-document.md +5 -45
- package/prompts/detail/update-document.md +145 -0
- package/prompts/evaluate/document-structure.md +94 -0
- package/prompts/evaluate/document.md +149 -0
- package/prompts/structure/document-rules.md +1 -1
- package/prompts/structure/generate-structure-system.md +74 -0
- package/prompts/structure/generate-structure-user.md +41 -0
- package/prompts/structure/update-document-structure.md +118 -0
- package/prompts/translate/translate-document.md +1 -1
- package/prompts/utils/feedback-refiner.md +3 -3
- package/release-please-config.json +1 -7
- package/tests/agents/clear/choose-contents.test.mjs +280 -0
- package/tests/agents/clear/clear-auth-tokens.test.mjs +268 -0
- package/tests/agents/clear/clear-document-config.test.mjs +167 -0
- package/tests/agents/clear/clear-document-structure.test.mjs +374 -0
- package/tests/agents/clear/clear-generated-docs.test.mjs +222 -0
- package/tests/agents/evaluate/code-snippet.test.mjs +163 -0
- package/tests/agents/evaluate/fixtures/api-services.md +87 -0
- package/tests/agents/evaluate/fixtures/js-sdk.md +94 -0
- package/tests/agents/evaluate/generate-report.test.mjs +312 -0
- package/tests/agents/generate/check-document-structure.test.mjs +0 -6
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +449 -0
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +410 -0
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +476 -0
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +548 -0
- package/tests/agents/generate/generate-structure.test.mjs +0 -6
- package/tests/agents/generate/user-review-document-structure.test.mjs +9 -9
- package/tests/agents/publish/publish-docs.test.mjs +2 -2
- package/tests/agents/update/check-update-is-single.test.mjs +300 -0
- package/tests/agents/update/document-tools/update-document-content.test.mjs +326 -0
- package/tests/agents/update/user-review-document.test.mjs +561 -0
- package/tests/agents/utils/format-document-structure.test.mjs +100 -0
- package/tests/utils/auth-utils.test.mjs +239 -1
- package/tests/utils/blocklet.test.mjs +9 -7
- package/tests/utils/constants.test.mjs +1 -1
- package/tests/utils/d2-utils.test.mjs +1 -1
- package/tests/utils/deploy.test.mjs +310 -366
- package/tests/utils/kroki-utils.test.mjs +2 -15
- package/tests/utils/linter/fixtures/css/keyword-error.css +1 -0
- package/tests/utils/linter/fixtures/css/missing-semicolon.css +1 -0
- package/tests/utils/linter/fixtures/css/syntax-error.css +1 -0
- package/tests/utils/linter/fixtures/css/undeclare-variable.css +1 -0
- package/tests/utils/linter/fixtures/css/unused-variable.css +2 -0
- package/tests/utils/linter/fixtures/css/valid-code.css +1 -0
- package/tests/utils/linter/fixtures/dockerfile/keyword-error.dockerfile +1 -0
- package/tests/utils/linter/fixtures/dockerfile/missing-semicolon.dockerfile +2 -0
- package/tests/utils/linter/fixtures/dockerfile/syntax-error.dockerfile +2 -0
- package/tests/utils/linter/fixtures/dockerfile/undeclare-variable.dockerfile +1 -0
- package/tests/utils/linter/fixtures/dockerfile/unused-variable.dockerfile +1 -0
- package/tests/utils/linter/fixtures/dockerfile/valid-code.dockerfile +2 -0
- package/tests/utils/linter/fixtures/go/keyword-error.go +5 -0
- package/tests/utils/linter/fixtures/go/missing-semicolon.go +5 -0
- package/tests/utils/linter/fixtures/go/syntax-error.go +6 -0
- package/tests/utils/linter/fixtures/go/undeclare-variable.go +5 -0
- package/tests/utils/linter/fixtures/go/unused-variable.go +5 -0
- package/tests/utils/linter/fixtures/go/valid-code.go +7 -0
- package/tests/utils/linter/fixtures/js/keyword-error.js +3 -0
- package/tests/utils/linter/fixtures/js/missing-semicolon.js +6 -0
- package/tests/utils/linter/fixtures/js/syntax-error.js +4 -0
- package/tests/utils/linter/fixtures/js/undeclare-variable.js +3 -0
- package/tests/utils/linter/fixtures/js/unused-variable.js +7 -0
- package/tests/utils/linter/fixtures/js/valid-code.js +15 -0
- package/tests/utils/linter/fixtures/json/keyword-error.json +1 -0
- package/tests/utils/linter/fixtures/json/missing-semicolon.json +1 -0
- package/tests/utils/linter/fixtures/json/syntax-error.json +1 -0
- package/tests/utils/linter/fixtures/json/undeclare-variable.json +1 -0
- package/tests/utils/linter/fixtures/json/unused-variable.json +1 -0
- package/tests/utils/linter/fixtures/json/valid-code.json +1 -0
- package/tests/utils/linter/fixtures/jsx/keyword-error.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/missing-semicolon.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/syntax-error.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/undeclare-variable.jsx +5 -0
- package/tests/utils/linter/fixtures/jsx/unused-variable.jsx +4 -0
- package/tests/utils/linter/fixtures/jsx/valid-code.jsx +5 -0
- package/tests/utils/linter/fixtures/python/keyword-error.py +3 -0
- package/tests/utils/linter/fixtures/python/missing-semicolon.py +2 -0
- package/tests/utils/linter/fixtures/python/syntax-error.py +3 -0
- package/tests/utils/linter/fixtures/python/undeclare-variable.py +3 -0
- package/tests/utils/linter/fixtures/python/unused-variable.py +6 -0
- package/tests/utils/linter/fixtures/python/valid-code.py +12 -0
- package/tests/utils/linter/fixtures/ruby/keyword-error.rb +2 -0
- package/tests/utils/linter/fixtures/ruby/missing-semicolon.rb +1 -0
- package/tests/utils/linter/fixtures/ruby/syntax-error.rb +2 -0
- package/tests/utils/linter/fixtures/ruby/undeclare-variable.rb +1 -0
- package/tests/utils/linter/fixtures/ruby/unused-variable.rb +2 -0
- package/tests/utils/linter/fixtures/ruby/valid-code.rb +1 -0
- package/tests/utils/linter/fixtures/sass/keyword-error.sass +2 -0
- package/tests/utils/linter/fixtures/sass/missing-semicolon.sass +3 -0
- package/tests/utils/linter/fixtures/sass/syntax-error.sass +3 -0
- package/tests/utils/linter/fixtures/sass/undeclare-variable.sass +2 -0
- package/tests/utils/linter/fixtures/sass/unused-variable.sass +4 -0
- package/tests/utils/linter/fixtures/sass/valid-code.sass +2 -0
- package/tests/utils/linter/fixtures/scss/keyword-error.scss +1 -0
- package/tests/utils/linter/fixtures/scss/missing-semicolon.scss +1 -0
- package/tests/utils/linter/fixtures/scss/syntax-error.scss +1 -0
- package/tests/utils/linter/fixtures/scss/undeclare-variable.scss +1 -0
- package/tests/utils/linter/fixtures/scss/unused-variable.scss +2 -0
- package/tests/utils/linter/fixtures/scss/valid-code.scss +1 -0
- package/tests/utils/linter/fixtures/shell/keyword-error.sh +5 -0
- package/tests/utils/linter/fixtures/shell/missing-semicolon.sh +3 -0
- package/tests/utils/linter/fixtures/shell/syntax-error.sh +4 -0
- package/tests/utils/linter/fixtures/shell/undeclare-variable.sh +3 -0
- package/tests/utils/linter/fixtures/shell/unused-variable.sh +4 -0
- package/tests/utils/linter/fixtures/shell/valid-code.sh +3 -0
- package/tests/utils/linter/fixtures/ts/keyword-error.ts +1 -0
- package/tests/utils/linter/fixtures/ts/missing-semicolon.ts +1 -0
- package/tests/utils/linter/fixtures/ts/syntax-error.ts +1 -0
- package/tests/utils/linter/fixtures/ts/undeclare-variable.ts +1 -0
- package/tests/utils/linter/fixtures/ts/unused-variable.ts +3 -0
- package/tests/utils/linter/fixtures/ts/valid-code.ts +3 -0
- package/tests/utils/linter/fixtures/tsx/keyword-error.tsx +5 -0
- package/tests/utils/linter/fixtures/tsx/missing-semicolon.tsx +5 -0
- package/tests/utils/linter/fixtures/tsx/syntax-error.tsx +5 -0
- package/tests/utils/linter/fixtures/tsx/undeclare-variable.tsx +6 -0
- package/tests/utils/linter/fixtures/tsx/unused-variable.tsx +6 -0
- package/tests/utils/linter/fixtures/tsx/valid-code.tsx +5 -0
- package/tests/utils/linter/fixtures/vue/keyword-error.vue +6 -0
- package/tests/utils/linter/fixtures/vue/missing-semicolon.vue +6 -0
- package/tests/utils/linter/fixtures/vue/syntax-error.vue +6 -0
- package/tests/utils/linter/fixtures/vue/undeclare-variable.vue +6 -0
- package/tests/utils/linter/fixtures/vue/unused-variable.vue +7 -0
- package/tests/utils/linter/fixtures/vue/valid-code.vue +6 -0
- package/tests/utils/linter/fixtures/yaml/keyword-error.yml +1 -0
- package/tests/utils/linter/fixtures/yaml/missing-semicolon.yml +2 -0
- package/tests/utils/linter/fixtures/yaml/syntax-error.yml +1 -0
- package/tests/utils/linter/fixtures/yaml/undeclare-variable.yml +1 -0
- package/tests/utils/linter/fixtures/yaml/unused-variable.yml +2 -0
- package/tests/utils/linter/fixtures/yaml/valid-code.yml +3 -0
- package/tests/utils/linter/index.test.mjs +440 -0
- package/tests/utils/linter/scan-results.mjs +42 -0
- package/tests/utils/markdown/index.test.mjs +478 -0
- package/tests/utils/mermaid-validator.test.mjs +2 -2
- package/tests/utils/utils.test.mjs +3 -1
- package/types/document-schema.mjs +54 -0
- package/types/document-structure-schema.mjs +244 -0
- package/utils/auth-utils.mjs +131 -6
- package/utils/conflict-detector.mjs +5 -1
- package/utils/{constants.mjs → constants/index.mjs} +109 -0
- package/utils/constants/linter.mjs +102 -0
- package/utils/d2-utils.mjs +2 -4
- package/utils/debug.mjs +3 -0
- package/utils/deploy.mjs +81 -385
- package/utils/evaluate/report-utils.mjs +131 -0
- package/utils/file-utils.mjs +36 -1
- package/utils/kroki-utils.mjs +1 -1
- package/utils/linter/index.mjs +50 -0
- package/utils/markdown/index.mjs +26 -0
- package/utils/markdown-checker.mjs +1 -1
- package/utils/utils.mjs +19 -7
- package/prompts/structure/generate-structure.md +0 -161
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# 發布您的文件
|
|
2
|
+
|
|
3
|
+
產生文件後,`aigne doc publish` 指令會將您的內容上傳到 Discuss Kit 平台,使其可以在線上存取。本指南將說明如何將您的文件發布到官方平台或您自己託管的網站。
|
|
4
|
+
|
|
5
|
+
## 發布流程
|
|
6
|
+
|
|
7
|
+
`aigne doc publish` 指令會啟動一個互動式流程。當您首次發布到新目標時,它會引導您進行身份驗證。後續的發布將使用已儲存的憑證。
|
|
8
|
+
|
|
9
|
+
```d2 發布流程 icon=lucide:upload-cloud
|
|
10
|
+
direction: down
|
|
11
|
+
shape: sequence_diagram
|
|
12
|
+
|
|
13
|
+
使用者: { shape: c4-person }
|
|
14
|
+
CLI: { label: "AIGNE CLI" }
|
|
15
|
+
瀏覽器: { label: "瀏覽器" }
|
|
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: "儲存權杖以供未來使用"
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
CLI -> 平台: "上傳文件與媒體檔案"
|
|
31
|
+
平台 -> CLI: "成功回應"
|
|
32
|
+
CLI -> 使用者: "✅ 發布成功!"
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## 發布選項
|
|
37
|
+
|
|
38
|
+
您有兩種主要選項來託管您的文件:
|
|
39
|
+
|
|
40
|
+
<x-cards data-columns="2">
|
|
41
|
+
<x-card data-title="官方平台" data-icon="lucide:globe">
|
|
42
|
+
發布到 [docsmith.aigne.io](https://docsmith.aigne.io/app/),這是由 AIGNE 提供的免費公開託管平台。對於開源專案或需要快速分享文件的情況,這是一個不錯的選擇。
|
|
43
|
+
</x-card>
|
|
44
|
+
<x-card data-title="您自己的網站" data-icon="lucide:server">
|
|
45
|
+
發布到您自己的 Discuss Kit 實例,以完全控制存取權限和品牌。這適用於內部或私密文件。您可以從 [Blocklet 商店](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu) 取得 Discuss Kit 實例。
|
|
46
|
+
</x-card>
|
|
47
|
+
</x-cards>
|
|
48
|
+
|
|
49
|
+
## 步驟指南
|
|
50
|
+
|
|
51
|
+
請按照以下步驟首次發布您的文件。
|
|
52
|
+
|
|
53
|
+
### 1. 執行發布指令
|
|
54
|
+
|
|
55
|
+
在您專案的根目錄中,執行以下指令:
|
|
56
|
+
|
|
57
|
+
```bash Terminal icon=lucide:terminal
|
|
58
|
+
aigne doc publish
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 2. 選擇您的平台
|
|
62
|
+
|
|
63
|
+
如果這是您第一次發布,系統會提示您選擇一個目標。請選擇符合您需求的選項。
|
|
64
|
+
|
|
65
|
+

|
|
66
|
+
|
|
67
|
+
如果您選擇自己的網站,系統會要求您輸入其 URL。
|
|
68
|
+
|
|
69
|
+
### 3. 驗證您的帳戶
|
|
70
|
+
|
|
71
|
+
首次連接到新平台時,會開啟一個瀏覽器視窗讓您登入並授權 CLI。每個平台只需執行此步驟一次;您的存取權杖會儲存在本地的 `~/.aigne/doc-smith-connected.yaml` 檔案中,以供未來使用。
|
|
72
|
+
|
|
73
|
+
### 4. 確認
|
|
74
|
+
|
|
75
|
+
上傳完成後,您的終端機中會顯示一條成功訊息。
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
✅ 文件發布成功!
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## 在 CI/CD 環境中發布
|
|
82
|
+
|
|
83
|
+
對於自動化工作流程,您可以提供參數和環境變數來繞過互動式提示。
|
|
84
|
+
|
|
85
|
+
| 方法 | 名稱 | 說明 |
|
|
86
|
+
|---|---|---|
|
|
87
|
+
| **參數** | `--appUrl` | 直接指定您的 Discuss Kit 實例的 URL。 |
|
|
88
|
+
| **環境變數** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供存取權杖,跳過互動式登入。 |
|
|
89
|
+
|
|
90
|
+
以下是一個適合 CI/CD 管線的非互動式發布指令範例:
|
|
91
|
+
|
|
92
|
+
```bash CI/CD 範例 icon=lucide:workflow
|
|
93
|
+
export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
|
|
94
|
+
aigne doc publish --appUrl https://docs.mycompany.com
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## 疑難排解
|
|
98
|
+
|
|
99
|
+
如果在發布過程中遇到問題,請檢查以下常見問題:
|
|
100
|
+
|
|
101
|
+
- **連線錯誤**:您提供的自行託管實例的 URL 可能不正確,或者伺服器無法連線。請驗證 URL 和您的網路連線。
|
|
102
|
+
|
|
103
|
+
- **無效的網站 URL**:該 URL 必須指向一個在 ArcBlock 平台上建立的有效網站。CLI 會顯示類似 `The provided URL is not a valid website on ArcBlock platform` 的錯誤。若要託管您的文件,您可以先從[商店取得 Discuss Kit 實例](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu)。
|
|
104
|
+
|
|
105
|
+
- **缺少必要元件**:目標網站必須安裝 Discuss Kit 元件。如果缺少該元件,CLI 將返回類似 `This website does not have required components for publishing` 的錯誤。請參考 [Discuss Kit 文件](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) 來新增必要的元件。
|
|
106
|
+
|
|
107
|
+
有關指令和選項的完整清單,請參考 [CLI 指令參考](./cli-reference.md)。
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 发布您的文档
|
|
2
2
|
|
|
3
|
-
生成文档后,`aigne doc publish`
|
|
3
|
+
生成文档后,`aigne doc publish` 命令会将您的内容上传到 Discuss Kit 平台,使其可以在线访问。本指南将说明如何将您的文档发布到官方平台或您自己的自托管网站。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 发布流程
|
|
6
6
|
|
|
7
|
-
`aigne doc publish`
|
|
7
|
+
`aigne doc publish` 命令会启动一个交互式流程。首次发布到新目的地时,它将引导您完成身份验证。后续的发布将使用已保存的凭据。
|
|
8
8
|
|
|
9
9
|
```d2 发布流程 icon=lucide:upload-cloud
|
|
10
10
|
direction: down
|
|
@@ -35,44 +35,44 @@ CLI -> User: "✅ 发布成功!"
|
|
|
35
35
|
|
|
36
36
|
## 发布选项
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
您有两个主要选项来托管您的文档:
|
|
39
39
|
|
|
40
40
|
<x-cards data-columns="2">
|
|
41
41
|
<x-card data-title="官方平台" data-icon="lucide:globe">
|
|
42
42
|
发布到 [docsmith.aigne.io](https://docsmith.aigne.io/app/),这是 AIGNE 提供的一个免费的公共托管平台。对于开源项目或希望快速分享文档的用户来说,这是一个不错的选择。
|
|
43
43
|
</x-card>
|
|
44
|
-
<x-card data-title="
|
|
45
|
-
|
|
44
|
+
<x-card data-title="您自己的网站" data-icon="lucide:server">
|
|
45
|
+
发布到您自己的 Discuss Kit 实例,以完全控制访问和品牌。这适用于内部或私有文档。您可以从 [Blocklet 商店](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu) 获取 Discuss Kit 实例。
|
|
46
46
|
</x-card>
|
|
47
47
|
</x-cards>
|
|
48
48
|
|
|
49
49
|
## 分步指南
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
请按照以下步骤首次发布您的文档。
|
|
52
52
|
|
|
53
53
|
### 1. 运行发布命令
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
在您的项目根目录中,运行以下命令:
|
|
56
56
|
|
|
57
57
|
```bash Terminal icon=lucide:terminal
|
|
58
58
|
aigne doc publish
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
-
### 2.
|
|
61
|
+
### 2. 选择您的平台
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
如果这是您第一次发布,系统将提示您选择一个目的地。请选择适合您需求的选项。
|
|
64
64
|
|
|
65
65
|

|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
如果您选择自己的网站,系统将要求您输入其 URL。
|
|
68
68
|
|
|
69
|
-
### 3.
|
|
69
|
+
### 3. 验证您的账户
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
首次连接到新平台时,将打开一个浏览器窗口供您登录并授权 CLI。每个平台只需执行一次此步骤;您的访问令牌将保存在本地的 `~/.aigne/doc-smith-connected.yaml` 文件中,以备将来使用。
|
|
72
72
|
|
|
73
73
|
### 4. 确认
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
上传完成后,您的终端将显示一条成功消息。
|
|
76
76
|
|
|
77
77
|
```
|
|
78
78
|
✅ 文档发布成功!
|
|
@@ -80,11 +80,11 @@ aigne doc publish
|
|
|
80
80
|
|
|
81
81
|
## 在 CI/CD 环境中发布
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
对于自动化工作流,您可以通过提供参数和环境变量来绕过交互式提示。
|
|
84
84
|
|
|
85
85
|
| 方法 | 名称 | 描述 |
|
|
86
86
|
|---|---|---|
|
|
87
|
-
| **参数** | `--appUrl` |
|
|
87
|
+
| **参数** | `--appUrl` | 直接指定您的 Discuss Kit 实例的 URL。 |
|
|
88
88
|
| **环境变量** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供访问令牌,跳过交互式登录。 |
|
|
89
89
|
|
|
90
90
|
以下是一个适用于 CI/CD 流程的非交互式发布命令示例:
|
|
@@ -94,14 +94,14 @@ export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
|
|
|
94
94
|
aigne doc publish --appUrl https://docs.mycompany.com
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
##
|
|
97
|
+
## 问题排查
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
如果在发布过程中遇到问题,请检查以下常见问题:
|
|
100
100
|
|
|
101
|
-
-
|
|
101
|
+
- **连接错误**:您提供的自托管实例的 URL 可能不正确,或者服务器可能无法访问。请验证 URL 和您的网络连接。
|
|
102
102
|
|
|
103
|
-
- **无效的网站 URL**:该 URL
|
|
103
|
+
- **无效的网站 URL**:该 URL 必须指向一个在 ArcBlock 平台上构建的有效网站。CLI 将显示类似 `The provided URL is not a valid website on ArcBlock platform` 的错误。要托管您的文档,您可以从[商店获取一个 Discuss Kit 实例](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu)开始。
|
|
104
104
|
|
|
105
|
-
- **缺少必需组件**:目标网站必须安装 Discuss Kit 组件。如果缺少该组件,CLI 将返回类似 `This website does not have required components for publishing` 的错误。请参阅 [Discuss Kit 文档](https://www.arcblock.io/docs/web3-kit/en/discuss-kit)
|
|
105
|
+
- **缺少必需组件**:目标网站必须安装 Discuss Kit 组件。如果缺少该组件,CLI 将返回类似 `This website does not have required components for publishing` 的错误。请参阅 [Discuss Kit 文档](https://www.arcblock.io/docs/web3-kit/en/discuss-kit)以添加必要的组件。
|
|
106
106
|
|
|
107
107
|
有关命令和选项的完整列表,请参阅 [CLI 命令参考](./cli-reference.md)。
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# ドキュメントの翻訳
|
|
2
|
+
|
|
3
|
+
AIGNE DocSmithは、ドキュメントを12の異なる言語に翻訳でき、プロジェクトを世界中のオーディエンスに届けることができます。このツールは翻訳を管理するための2つの方法を提供します。ガイド付きセットアップのためのインタラクティブモードと、正確な制御と自動化のためのコマンドライン引数です。
|
|
4
|
+
|
|
5
|
+
## インタラクティブな翻訳
|
|
6
|
+
|
|
7
|
+
ガイド付きの体験には、引数なしで`translate`コマンドを実行します。これは、ステップバイステップのプロセスを好むユーザーに最適です。
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
aigne doc translate
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
このコマンドは、プロセスを案内するインタラクティブなウィザードを起動します。
|
|
14
|
+
|
|
15
|
+
1. **翻訳するドキュメントを選択:**既存のドキュメントのリストが表示されます。スペースバーを使用して、翻訳したいものを選択します。
|
|
16
|
+
|
|
17
|
+

|
|
18
|
+
|
|
19
|
+
2. **ターゲット言語を選択:**ドキュメントを選択した後、サポートされているオプションのリストから1つ以上のターゲット言語を選びます。
|
|
20
|
+
|
|
21
|
+

|
|
22
|
+
|
|
23
|
+
3. **確認と実行:**DocSmithは翻訳を処理し、選択した各言語に対して選択されたファイルの新しいバージョンを生成します。
|
|
24
|
+
|
|
25
|
+
## コマンドラインによる翻訳
|
|
26
|
+
|
|
27
|
+
スクリプトやCI/CDパイプラインでの自動化には、コマンドラインフラグを使用して翻訳プロセスを制御します。この方法は、開発者や上級ユーザーに適しています。
|
|
28
|
+
|
|
29
|
+
### コマンドパラメータ
|
|
30
|
+
|
|
31
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="ターゲット言語を1つ指定します。このフラグを複数回使用して、複数の言語を含めることができます(例:--langs zh --langs ja)。"></x-field>
|
|
32
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="翻訳するドキュメントのパスを指定します。これも複数回使用してバッチ翻訳が可能です。"></x-field>
|
|
33
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="AIに提案を提供して、翻訳の品質をガイドします(例:--feedback "フォーマルなトーンを使用してください")。"></x-field>
|
|
34
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="Markdown形式の用語集ファイルを使用して、特定の用語の一貫性を確保します(例:--glossary @path/to/glossary.md)。"></x-field>
|
|
35
|
+
|
|
36
|
+
### 例
|
|
37
|
+
|
|
38
|
+
#### 特定のドキュメントの翻訳
|
|
39
|
+
|
|
40
|
+
`overview.md`と`examples.md`を中国語と日本語に翻訳するには、以下を実行します。
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### 用語集とフィードバックの使用
|
|
47
|
+
|
|
48
|
+
ブランド名や技術用語が正しく翻訳されるように、用語集ファイルを提供できます。また、フィードバックを与えて翻訳スタイルを洗練させることもできます。
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## サポートされている言語
|
|
55
|
+
|
|
56
|
+
DocSmithは、以下の言語の自動翻訳をサポートしています。
|
|
57
|
+
|
|
58
|
+
| Language | Code |
|
|
59
|
+
|---|---|
|
|
60
|
+
| 英語 | en |
|
|
61
|
+
| 簡体字中国語 | zh-CN |
|
|
62
|
+
| 繁体字中国語 | zh-TW |
|
|
63
|
+
| 日本語 | ja |
|
|
64
|
+
| 韓国語 | ko |
|
|
65
|
+
| スペイン語 | es |
|
|
66
|
+
| フランス語 | fr |
|
|
67
|
+
| ドイツ語 | de |
|
|
68
|
+
| ポルトガル語 | pt-BR |
|
|
69
|
+
| ロシア語 | ru |
|
|
70
|
+
| イタリア語 | it |
|
|
71
|
+
| アラビア語 | ar |
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
ドキュメントが翻訳されたら、世界と共有する準備が整いました。
|
|
76
|
+
|
|
77
|
+
<x-card data-title="次へ:ドキュメントの公開" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="続きを読む">
|
|
78
|
+
ドキュメントを公開プラットフォームまたは独自のプライベートウェブサイトに公開する方法についてのガイド。
|
|
79
|
+
</x-card>
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# 翻譯文件
|
|
2
|
+
|
|
3
|
+
AIGNE DocSmith 可以將您的文件翻譯成 12 種不同的語言,讓您的專案能夠觸及全球受眾。此工具提供兩種管理翻譯的方式:用於引導式設定的互動模式,以及用於精確控制和自動化的命令列參數。
|
|
4
|
+
|
|
5
|
+
## 互動式翻譯
|
|
6
|
+
|
|
7
|
+
若想獲得引導式體驗,請執行不含任何參數的 `translate` 指令。這對於偏好逐步操作的使用者來說非常理想。
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
aigne doc translate
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
此指令會啟動一個互動式精靈,引導您完成整個過程:
|
|
14
|
+
|
|
15
|
+
1. **選取要翻譯的文件:** 您將看到現有文件的列表。使用空格鍵選取您想要翻譯的文件。
|
|
16
|
+
|
|
17
|
+

|
|
18
|
+
|
|
19
|
+
2. **選擇目標語言:** 選取文件後,從支援的選項列表中選擇一種或多種目標語言。
|
|
20
|
+
|
|
21
|
+

|
|
22
|
+
|
|
23
|
+
3. **確認並執行:** 接著 DocSmith 將處理翻譯,為每個選擇的語言產生您所選檔案的新版本。
|
|
24
|
+
|
|
25
|
+
## 命令列翻譯
|
|
26
|
+
|
|
27
|
+
對於指令稿或 CI/CD 管線中的自動化,請使用命令列旗標來控制翻譯過程。此方法適合開發人員和進階使用者。
|
|
28
|
+
|
|
29
|
+
### 指令參數
|
|
30
|
+
|
|
31
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一個目標語言。此旗標可多次使用以包含多種語言(例如,--langs zh --langs ja)。"></x-field>
|
|
32
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻譯的文件的路徑。此旗標也可多次使用以進行批次翻譯。"></x-field>
|
|
33
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建議以引導翻譯品質(例如,--feedback "使用正式語氣")。"></x-field>
|
|
34
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的詞彙表檔案,以確保特定術語的術語一致性(例如,--glossary @path/to/glossary.md)。"></x-field>
|
|
35
|
+
|
|
36
|
+
### 範例
|
|
37
|
+
|
|
38
|
+
#### 翻譯特定文件
|
|
39
|
+
|
|
40
|
+
若要將 `overview.md` 和 `examples.md` 翻譯成中文和日文,請執行:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### 使用詞彙表和回饋
|
|
47
|
+
|
|
48
|
+
為確保品牌名稱和技術術語翻譯正確,您可以提供一個詞彙表檔案。您也可以提供回饋來改善翻譯風格。
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 支援的語言
|
|
55
|
+
|
|
56
|
+
DocSmith 支援以下語言的自動翻譯:
|
|
57
|
+
|
|
58
|
+
| 語言 | 代碼 |
|
|
59
|
+
|---|---|
|
|
60
|
+
| 英文 | en |
|
|
61
|
+
| 簡體中文 | zh-CN |
|
|
62
|
+
| 繁體中文 | zh-TW |
|
|
63
|
+
| 日文 | ja |
|
|
64
|
+
| 韓文 | ko |
|
|
65
|
+
| 西班牙文 | es |
|
|
66
|
+
| 法文 | fr |
|
|
67
|
+
| 德文 | de |
|
|
68
|
+
| 葡萄牙文 | pt-BR |
|
|
69
|
+
| 俄文 | ru |
|
|
70
|
+
| 義大利文 | it |
|
|
71
|
+
| 阿拉伯文 | ar |
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
文件翻譯完成後,您就可以與世界分享了。
|
|
76
|
+
|
|
77
|
+
<x-card data-title="下一步:發佈您的文件" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="閱讀更多">
|
|
78
|
+
關於如何將您的文件發佈到公共平台或您自己的私人網站的指南。
|
|
79
|
+
</x-card>
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# 翻译文档
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmith 可以将您的文档翻译成 12 种不同的语言,使您的项目能够覆盖全球受众。该工具提供两种管理翻译的方式:用于引导式设置的交互模式和用于精确控制和自动化的命令行参数。
|
|
4
4
|
|
|
5
5
|
## 交互式翻译
|
|
6
6
|
|
|
7
|
-
如需引导式体验,请运行不带任何参数的 `translate`
|
|
7
|
+
如需引导式体验,请运行不带任何参数的 `translate` 命令。这对于喜欢逐步操作的用户来说是理想的选择。
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
此命令会启动一个交互式向导,引导您完成整个过程:
|
|
14
14
|
|
|
15
|
-
1. **选择要翻译的文档:**
|
|
15
|
+
1. **选择要翻译的文档:** 您将看到一个现有文档的列表。使用空格键选择您想要翻译的文档。
|
|
16
16
|
|
|
17
17
|

|
|
18
18
|
|
|
@@ -24,13 +24,13 @@ aigne doc translate
|
|
|
24
24
|
|
|
25
25
|
## 命令行翻译
|
|
26
26
|
|
|
27
|
-
对于脚本或 CI/CD
|
|
27
|
+
对于脚本或 CI/CD 管道中的自动化,请使用命令行标志来控制翻译过程。此方法适合开发人员和高级用户。
|
|
28
28
|
|
|
29
29
|
### 命令参数
|
|
30
30
|
|
|
31
|
-
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="
|
|
32
|
-
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="
|
|
33
|
-
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建议以指导翻译质量(例如,--feedback "
|
|
31
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一个目标语言。此标志可以多次使用以包含多种语言(例如,--langs zh --langs ja)。"></x-field>
|
|
32
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻译的文档的路径。此标志也可以多次使用以进行批量翻译。"></x-field>
|
|
33
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建议以指导翻译质量(例如,--feedback "使用正式语气")。"></x-field>
|
|
34
34
|
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的术语表文件,以确保特定术语的一致性(例如,--glossary @path/to/glossary.md)。"></x-field>
|
|
35
35
|
|
|
36
36
|
### 示例
|
|
@@ -45,7 +45,7 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
45
45
|
|
|
46
46
|
#### 使用术语表和反馈
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
为确保品牌名称和技术术语翻译正确,您可以提供一个术语表文件。您还可以提供反馈以优化翻译风格。
|
|
49
49
|
|
|
50
50
|
```bash
|
|
51
51
|
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
@@ -72,8 +72,8 @@ DocSmith 支持以下语言的自动翻译:
|
|
|
72
72
|
|
|
73
73
|
---
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
文档翻译完成后,您就可以与世界分享了。
|
|
76
76
|
|
|
77
|
-
<x-card data-title="
|
|
78
|
-
|
|
77
|
+
<x-card data-title="下一步:发布您的文档" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="阅读更多">
|
|
78
|
+
关于如何将您的文档发布到公共平台或您自己的私人网站的指南。
|
|
79
79
|
</x-card>
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# 更新と改良
|
|
2
|
+
|
|
3
|
+
進化するコードベースとドキュメントを同期させることは、重要なタスクです。AIGNE DocSmithは、コードの変更に基づく自動更新や、フィードバックに基づいた正確な改良を通じて、コンテンツを最新の状態に保つための直接的で柔軟な方法を提供します。
|
|
4
|
+
|
|
5
|
+
このガイドでは、以下の方法について説明します:
|
|
6
|
+
|
|
7
|
+
- ソースコードが変更されたときにドキュメントを自動的に更新する。
|
|
8
|
+
- 特定のフィードバックを使用して特定のドキュメントを再生成する。
|
|
9
|
+
- ドキュメント全体の構造を調整する。
|
|
10
|
+
|
|
11
|
+
### ドキュメント更新のワークフロー
|
|
12
|
+
|
|
13
|
+
以下の図は、ドキュメントを更新するために利用できるさまざまなパスを示しています:
|
|
14
|
+
|
|
15
|
+
```d2 更新ワークフロー
|
|
16
|
+
direction: down
|
|
17
|
+
|
|
18
|
+
Start: {
|
|
19
|
+
shape: circle
|
|
20
|
+
label: "開始"
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
Code-Change: {
|
|
24
|
+
label: "ソースコードまたは\n設定の変更"
|
|
25
|
+
shape: rectangle
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
Content-Tweak: {
|
|
29
|
+
label: "コンテンツの\n改善が必要か?"
|
|
30
|
+
shape: rectangle
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
Structure-Tweak: {
|
|
34
|
+
label: "構造の\n改善が必要か?"
|
|
35
|
+
shape: rectangle
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
Start -> Code-Change
|
|
39
|
+
Start -> Content-Tweak
|
|
40
|
+
Start -> Structure-Tweak
|
|
41
|
+
|
|
42
|
+
Code-Change -> Generate-Command: "aigne doc generate"
|
|
43
|
+
|
|
44
|
+
Generate-Command -> Change-Detection: {
|
|
45
|
+
label: "変更検出"
|
|
46
|
+
shape: diamond
|
|
47
|
+
}
|
|
48
|
+
Change-Detection -> Auto-Regen: "影響を受ける\nドキュメントを再生成"
|
|
49
|
+
|
|
50
|
+
Content-Tweak -> Update-Command: "aigne doc update\n--feedback"
|
|
51
|
+
Update-Command -> Manual-Regen: "特定の\nドキュメントを再生成"
|
|
52
|
+
|
|
53
|
+
Structure-Tweak -> Generate-Feedback-Command: "aigne doc generate\n--feedback"
|
|
54
|
+
Generate-Feedback-Command -> Replan: "ドキュメント構造を\n再計画"
|
|
55
|
+
|
|
56
|
+
End: {
|
|
57
|
+
shape: circle
|
|
58
|
+
label: "ドキュメント更新済み"
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
Auto-Regen -> End
|
|
62
|
+
Manual-Regen -> End
|
|
63
|
+
Replan -> End
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 変更検出による自動更新
|
|
69
|
+
|
|
70
|
+
`aigne doc generate` コマンドを実行すると、DocSmithはコードベースを分析し、前回の実行からの変更を検出し、影響を受けるドキュメントのみを再生成します。このプロセスにより、時間を節約し、不要なAPI呼び出しを削減できます。
|
|
71
|
+
|
|
72
|
+
```shell icon=lucide:terminal
|
|
73
|
+
# DocSmithが変更を検出し、必要なものだけを更新します
|
|
74
|
+
aigne doc generate
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+

|
|
78
|
+
|
|
79
|
+
### 完全な再生成を強制する
|
|
80
|
+
|
|
81
|
+
キャッシュや以前の状態を無視して、すべてのドキュメントを最初から再生成する必要がある場合は、`--forceRegenerate` フラグを使用します。これは、大幅な設定変更後や、完全に新しいビルドを確実にしたい場合に便利です。
|
|
82
|
+
|
|
83
|
+
```shell icon=lucide:terminal
|
|
84
|
+
# すべてのドキュメントをゼロから再生成します
|
|
85
|
+
aigne doc generate --forceRegenerate
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 個々のドキュメントの改良
|
|
91
|
+
|
|
92
|
+
対応するコードの変更なしに特定のドキュメントを改善するために、`aigne doc update` コマンドを使用すると、コンテンツの改良に関する的を絞った指示を提供できます。
|
|
93
|
+
|
|
94
|
+
このコマンドは、対話形式またはコマンドライン引数を介して直接、2つの方法で使用できます。
|
|
95
|
+
|
|
96
|
+
### 対話モード
|
|
97
|
+
|
|
98
|
+
ガイド付きの体験をしたい場合は、引数なしでコマンドを実行します。DocSmithは、更新したいドキュメントを選択するためのメニューを表示します。選択後、フィードバックを入力するよう求められます。
|
|
99
|
+
|
|
100
|
+
```shell icon=lucide:terminal
|
|
101
|
+
# 対話式の更新プロセスを開始します
|
|
102
|
+
aigne doc update
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+

|
|
106
|
+
|
|
107
|
+
### 直接的なコマンドライン更新
|
|
108
|
+
|
|
109
|
+
より高速なワークフローやスクリプト作成のために、フラグを使用してドキュメントとフィードバックを直接指定できます。これにより、正確で非対話的な更新が可能になります。
|
|
110
|
+
|
|
111
|
+
```shell icon=lucide:terminal
|
|
112
|
+
# 特定のドキュメントにフィードバックを付けて更新します
|
|
113
|
+
aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
`update` コマンドの主要なパラメータ:
|
|
117
|
+
|
|
118
|
+
| パラメータ | 説明 |
|
|
119
|
+
| ---------- | ------------------------------------------------------------------------------------------------ |
|
|
120
|
+
| `--docs` | 更新したいドキュメントへのパス。バッチ更新のためにこのフラグを複数回使用できます。 |
|
|
121
|
+
| `--feedback` | コンテンツを再生成する際に使用する具体的な指示。 |
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## 全体構造の最適化
|
|
126
|
+
|
|
127
|
+
個々のドキュメントのコンテンツを改良するだけでなく、ドキュメント全体の構造も調整できます。セクションが欠けている場合や、既存の構成を改善できる場合は、`generate` コマンドにフィードバックを提供できます。
|
|
128
|
+
|
|
129
|
+
このコマンドは、DocSmithに新しい入力に基づいてドキュメントプラン全体を再評価するよう指示します。
|
|
130
|
+
|
|
131
|
+
```shell icon=lucide:terminal
|
|
132
|
+
# 特定のフィードバックを付けてドキュメント構造を再生成します
|
|
133
|
+
aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
このアプローチは、行単位のコンテンツ編集ではなく、ドキュメントの目次に対する高レベルの変更に最適です。
|
|
137
|
+
|
|
138
|
+
これらのツールを使用すると、プロジェクトと共に進化する正確なドキュメントを維持できます。コンテンツが改良されたら、世界中のオーディエンスに公開できます。その方法については、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドで学んでください。
|