@aigne/doc-smith 0.8.12-beta.8 → 0.8.12
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/CHANGELOG.md +15 -0
- package/agents/publish/index.yaml +4 -0
- package/agents/publish/publish-docs.mjs +77 -5
- package/agents/publish/translate-meta.mjs +103 -0
- package/agents/update/generate-document.yaml +30 -28
- package/agents/update/update-document-detail.yaml +3 -1
- package/agents/utils/update-branding.mjs +69 -0
- package/package.json +16 -2
- package/prompts/common/document/role-and-personality.md +3 -1
- package/prompts/detail/d2-diagram/guide.md +7 -1
- package/prompts/detail/d2-diagram/user-prompt.md +3 -0
- package/prompts/detail/generate/system-prompt.md +6 -7
- package/prompts/detail/generate/user-prompt.md +12 -3
- package/prompts/detail/update/user-prompt.md +0 -2
- package/prompts/structure/update/user-prompt.md +0 -4
- package/utils/file-utils.mjs +69 -24
- package/utils/markdown-checker.mjs +0 -20
- package/utils/request.mjs +7 -0
- package/utils/upload-files.mjs +231 -0
- package/utils/utils.mjs +11 -1
- package/.aigne/doc-smith/config.yaml +0 -77
- package/.aigne/doc-smith/history.yaml +0 -37
- package/.aigne/doc-smith/media-description.yaml +0 -91
- package/.aigne/doc-smith/output/structure-plan.json +0 -162
- package/.aigne/doc-smith/preferences.yml +0 -97
- package/.aigne/doc-smith/upload-cache.yaml +0 -1830
- package/.github/PULL_REQUEST_TEMPLATE.md +0 -28
- package/.github/workflows/ci.yml +0 -54
- package/.github/workflows/create-release-pr.yaml +0 -21
- package/.github/workflows/publish-docs.yml +0 -65
- package/.github/workflows/release.yml +0 -49
- package/.github/workflows/reviewer.yml +0 -54
- package/.release-please-manifest.json +0 -3
- package/RELEASE.md +0 -9
- package/assets/screenshots/doc-complete-setup.png +0 -0
- package/assets/screenshots/doc-generate-docs.png +0 -0
- package/assets/screenshots/doc-generate.png +0 -0
- package/assets/screenshots/doc-generated-successfully.png +0 -0
- package/assets/screenshots/doc-publish.png +0 -0
- package/assets/screenshots/doc-regenerate.png +0 -0
- package/assets/screenshots/doc-translate-langs.png +0 -0
- package/assets/screenshots/doc-translate.png +0 -0
- package/assets/screenshots/doc-update.png +0 -0
- package/biome.json +0 -73
- package/codecov.yml +0 -15
- package/docs/_sidebar.md +0 -15
- package/docs/configuration-initial-setup.ja.md +0 -179
- package/docs/configuration-initial-setup.md +0 -198
- package/docs/configuration-initial-setup.zh-TW.md +0 -179
- package/docs/configuration-initial-setup.zh.md +0 -179
- package/docs/configuration-managing-preferences.ja.md +0 -100
- package/docs/configuration-managing-preferences.md +0 -100
- package/docs/configuration-managing-preferences.zh-TW.md +0 -100
- package/docs/configuration-managing-preferences.zh.md +0 -100
- package/docs/configuration.ja.md +0 -69
- package/docs/configuration.md +0 -69
- package/docs/configuration.zh-TW.md +0 -69
- package/docs/configuration.zh.md +0 -69
- package/docs/getting-started.ja.md +0 -107
- package/docs/getting-started.md +0 -107
- package/docs/getting-started.zh-TW.md +0 -107
- package/docs/getting-started.zh.md +0 -107
- package/docs/guides-cleaning-up.ja.md +0 -51
- package/docs/guides-cleaning-up.md +0 -52
- package/docs/guides-cleaning-up.zh-TW.md +0 -51
- package/docs/guides-cleaning-up.zh.md +0 -51
- package/docs/guides-evaluating-documents.ja.md +0 -66
- package/docs/guides-evaluating-documents.md +0 -107
- package/docs/guides-evaluating-documents.zh-TW.md +0 -66
- package/docs/guides-evaluating-documents.zh.md +0 -66
- package/docs/guides-generating-documentation.ja.md +0 -151
- package/docs/guides-generating-documentation.md +0 -89
- package/docs/guides-generating-documentation.zh-TW.md +0 -151
- package/docs/guides-generating-documentation.zh.md +0 -151
- package/docs/guides-interactive-chat.ja.md +0 -85
- package/docs/guides-interactive-chat.md +0 -93
- package/docs/guides-interactive-chat.zh-TW.md +0 -85
- package/docs/guides-interactive-chat.zh.md +0 -85
- package/docs/guides-managing-history.ja.md +0 -48
- package/docs/guides-managing-history.md +0 -53
- package/docs/guides-managing-history.zh-TW.md +0 -48
- package/docs/guides-managing-history.zh.md +0 -48
- package/docs/guides-publishing-your-docs.ja.md +0 -78
- package/docs/guides-publishing-your-docs.md +0 -83
- package/docs/guides-publishing-your-docs.zh-TW.md +0 -78
- package/docs/guides-publishing-your-docs.zh.md +0 -78
- package/docs/guides-translating-documentation.ja.md +0 -95
- package/docs/guides-translating-documentation.md +0 -100
- package/docs/guides-translating-documentation.zh-TW.md +0 -95
- package/docs/guides-translating-documentation.zh.md +0 -95
- package/docs/guides-updating-documentation.ja.md +0 -77
- package/docs/guides-updating-documentation.md +0 -79
- package/docs/guides-updating-documentation.zh-TW.md +0 -77
- package/docs/guides-updating-documentation.zh.md +0 -77
- package/docs/guides.ja.md +0 -32
- package/docs/guides.md +0 -32
- package/docs/guides.zh-TW.md +0 -32
- package/docs/guides.zh.md +0 -32
- package/docs/overview.ja.md +0 -61
- package/docs/overview.md +0 -61
- package/docs/overview.zh-TW.md +0 -61
- package/docs/overview.zh.md +0 -61
- package/docs/release-notes.ja.md +0 -255
- package/docs/release-notes.md +0 -288
- package/docs/release-notes.zh-TW.md +0 -255
- package/docs/release-notes.zh.md +0 -255
- package/prompts/common/afs/afs-tools-usage.md +0 -5
- package/prompts/common/afs/use-afs-instruction.md +0 -1
- package/release-please-config.json +0 -14
- package/tests/agents/chat/chat.test.mjs +0 -46
- package/tests/agents/clear/choose-contents.test.mjs +0 -284
- package/tests/agents/clear/clear-auth-tokens.test.mjs +0 -268
- package/tests/agents/clear/clear-document-config.test.mjs +0 -167
- package/tests/agents/clear/clear-document-structure.test.mjs +0 -380
- package/tests/agents/clear/clear-generated-docs.test.mjs +0 -222
- package/tests/agents/evaluate/code-snippet.test.mjs +0 -163
- package/tests/agents/evaluate/fixtures/api-services.md +0 -87
- package/tests/agents/evaluate/fixtures/js-sdk.md +0 -94
- package/tests/agents/evaluate/generate-report.test.mjs +0 -312
- package/tests/agents/generate/check-document-structure.test.mjs +0 -45
- package/tests/agents/generate/check-need-generate-structure.test.mjs +0 -279
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +0 -449
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +0 -410
- package/tests/agents/generate/document-structure-tools/generate-sub-structure.test.mjs +0 -277
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +0 -476
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +0 -548
- package/tests/agents/generate/generate-structure.test.mjs +0 -45
- package/tests/agents/generate/user-review-document-structure.test.mjs +0 -319
- package/tests/agents/history/view.test.mjs +0 -97
- package/tests/agents/init/init.test.mjs +0 -1657
- package/tests/agents/prefs/prefs.test.mjs +0 -431
- package/tests/agents/publish/publish-docs.test.mjs +0 -787
- package/tests/agents/translate/choose-language.test.mjs +0 -311
- package/tests/agents/translate/translate-document.test.mjs +0 -51
- package/tests/agents/update/check-document.test.mjs +0 -463
- package/tests/agents/update/check-update-is-single.test.mjs +0 -300
- package/tests/agents/update/document-tools/update-document-content.test.mjs +0 -329
- package/tests/agents/update/generate-document.test.mjs +0 -51
- package/tests/agents/update/save-and-translate-document.test.mjs +0 -369
- package/tests/agents/update/user-review-document.test.mjs +0 -582
- package/tests/agents/utils/action-success.test.mjs +0 -54
- package/tests/agents/utils/check-detail-result.test.mjs +0 -743
- package/tests/agents/utils/check-feedback-refiner.test.mjs +0 -478
- package/tests/agents/utils/choose-docs.test.mjs +0 -406
- package/tests/agents/utils/exit.test.mjs +0 -70
- package/tests/agents/utils/feedback-refiner.test.mjs +0 -51
- package/tests/agents/utils/find-item-by-path.test.mjs +0 -517
- package/tests/agents/utils/find-user-preferences-by-path.test.mjs +0 -382
- package/tests/agents/utils/format-document-structure.test.mjs +0 -364
- package/tests/agents/utils/fs.test.mjs +0 -267
- package/tests/agents/utils/load-sources.test.mjs +0 -1470
- package/tests/agents/utils/save-docs.test.mjs +0 -109
- package/tests/agents/utils/save-output.test.mjs +0 -315
- package/tests/agents/utils/save-single-doc.test.mjs +0 -364
- package/tests/agents/utils/transform-detail-datasources.test.mjs +0 -320
- package/tests/utils/auth-utils.test.mjs +0 -596
- package/tests/utils/blocklet.test.mjs +0 -336
- package/tests/utils/conflict-detector.test.mjs +0 -355
- package/tests/utils/constants.test.mjs +0 -295
- package/tests/utils/d2-utils.test.mjs +0 -437
- package/tests/utils/deploy.test.mjs +0 -399
- package/tests/utils/docs-finder-utils.test.mjs +0 -650
- package/tests/utils/file-utils.test.mjs +0 -521
- package/tests/utils/history-utils.test.mjs +0 -206
- package/tests/utils/kroki-utils.test.mjs +0 -646
- package/tests/utils/linter/fixtures/css/keyword-error.css +0 -1
- package/tests/utils/linter/fixtures/css/missing-semicolon.css +0 -1
- package/tests/utils/linter/fixtures/css/syntax-error.css +0 -1
- package/tests/utils/linter/fixtures/css/undeclare-variable.css +0 -1
- package/tests/utils/linter/fixtures/css/unused-variable.css +0 -2
- package/tests/utils/linter/fixtures/css/valid-code.css +0 -1
- package/tests/utils/linter/fixtures/dockerfile/keyword-error.dockerfile +0 -1
- package/tests/utils/linter/fixtures/dockerfile/missing-semicolon.dockerfile +0 -2
- package/tests/utils/linter/fixtures/dockerfile/syntax-error.dockerfile +0 -2
- package/tests/utils/linter/fixtures/dockerfile/undeclare-variable.dockerfile +0 -1
- package/tests/utils/linter/fixtures/dockerfile/unused-variable.dockerfile +0 -1
- package/tests/utils/linter/fixtures/dockerfile/valid-code.dockerfile +0 -2
- package/tests/utils/linter/fixtures/go/keyword-error.go +0 -5
- package/tests/utils/linter/fixtures/go/missing-semicolon.go +0 -5
- package/tests/utils/linter/fixtures/go/syntax-error.go +0 -6
- package/tests/utils/linter/fixtures/go/undeclare-variable.go +0 -5
- package/tests/utils/linter/fixtures/go/unused-variable.go +0 -5
- package/tests/utils/linter/fixtures/go/valid-code.go +0 -7
- package/tests/utils/linter/fixtures/js/keyword-error.js +0 -3
- package/tests/utils/linter/fixtures/js/missing-semicolon.js +0 -6
- package/tests/utils/linter/fixtures/js/syntax-error.js +0 -4
- package/tests/utils/linter/fixtures/js/undeclare-variable.js +0 -3
- package/tests/utils/linter/fixtures/js/unused-variable.js +0 -7
- package/tests/utils/linter/fixtures/js/valid-code.js +0 -15
- package/tests/utils/linter/fixtures/json/keyword-error.json +0 -1
- package/tests/utils/linter/fixtures/json/missing-semicolon.json +0 -1
- package/tests/utils/linter/fixtures/json/syntax-error.json +0 -1
- package/tests/utils/linter/fixtures/json/undeclare-variable.json +0 -1
- package/tests/utils/linter/fixtures/json/unused-variable.json +0 -1
- package/tests/utils/linter/fixtures/json/valid-code.json +0 -1
- package/tests/utils/linter/fixtures/jsx/keyword-error.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/missing-semicolon.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/syntax-error.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/undeclare-variable.jsx +0 -5
- package/tests/utils/linter/fixtures/jsx/unused-variable.jsx +0 -4
- package/tests/utils/linter/fixtures/jsx/valid-code.jsx +0 -5
- package/tests/utils/linter/fixtures/python/keyword-error.py +0 -3
- package/tests/utils/linter/fixtures/python/missing-semicolon.py +0 -2
- package/tests/utils/linter/fixtures/python/syntax-error.py +0 -3
- package/tests/utils/linter/fixtures/python/undeclare-variable.py +0 -3
- package/tests/utils/linter/fixtures/python/unused-variable.py +0 -6
- package/tests/utils/linter/fixtures/python/valid-code.py +0 -12
- package/tests/utils/linter/fixtures/ruby/keyword-error.rb +0 -2
- package/tests/utils/linter/fixtures/ruby/missing-semicolon.rb +0 -1
- package/tests/utils/linter/fixtures/ruby/syntax-error.rb +0 -2
- package/tests/utils/linter/fixtures/ruby/undeclare-variable.rb +0 -1
- package/tests/utils/linter/fixtures/ruby/unused-variable.rb +0 -2
- package/tests/utils/linter/fixtures/ruby/valid-code.rb +0 -1
- package/tests/utils/linter/fixtures/sass/keyword-error.sass +0 -2
- package/tests/utils/linter/fixtures/sass/missing-semicolon.sass +0 -3
- package/tests/utils/linter/fixtures/sass/syntax-error.sass +0 -3
- package/tests/utils/linter/fixtures/sass/undeclare-variable.sass +0 -2
- package/tests/utils/linter/fixtures/sass/unused-variable.sass +0 -4
- package/tests/utils/linter/fixtures/sass/valid-code.sass +0 -2
- package/tests/utils/linter/fixtures/scss/keyword-error.scss +0 -1
- package/tests/utils/linter/fixtures/scss/missing-semicolon.scss +0 -1
- package/tests/utils/linter/fixtures/scss/syntax-error.scss +0 -1
- package/tests/utils/linter/fixtures/scss/undeclare-variable.scss +0 -1
- package/tests/utils/linter/fixtures/scss/unused-variable.scss +0 -2
- package/tests/utils/linter/fixtures/scss/valid-code.scss +0 -1
- package/tests/utils/linter/fixtures/shell/keyword-error.sh +0 -5
- package/tests/utils/linter/fixtures/shell/missing-semicolon.sh +0 -3
- package/tests/utils/linter/fixtures/shell/syntax-error.sh +0 -4
- package/tests/utils/linter/fixtures/shell/undeclare-variable.sh +0 -3
- package/tests/utils/linter/fixtures/shell/unused-variable.sh +0 -4
- package/tests/utils/linter/fixtures/shell/valid-code.sh +0 -3
- package/tests/utils/linter/fixtures/ts/keyword-error.ts +0 -1
- package/tests/utils/linter/fixtures/ts/missing-semicolon.ts +0 -1
- package/tests/utils/linter/fixtures/ts/syntax-error.ts +0 -1
- package/tests/utils/linter/fixtures/ts/undeclare-variable.ts +0 -1
- package/tests/utils/linter/fixtures/ts/unused-variable.ts +0 -3
- package/tests/utils/linter/fixtures/ts/valid-code.ts +0 -3
- package/tests/utils/linter/fixtures/tsx/keyword-error.tsx +0 -5
- package/tests/utils/linter/fixtures/tsx/missing-semicolon.tsx +0 -5
- package/tests/utils/linter/fixtures/tsx/syntax-error.tsx +0 -5
- package/tests/utils/linter/fixtures/tsx/undeclare-variable.tsx +0 -6
- package/tests/utils/linter/fixtures/tsx/unused-variable.tsx +0 -6
- package/tests/utils/linter/fixtures/tsx/valid-code.tsx +0 -5
- package/tests/utils/linter/fixtures/vue/keyword-error.vue +0 -6
- package/tests/utils/linter/fixtures/vue/missing-semicolon.vue +0 -6
- package/tests/utils/linter/fixtures/vue/syntax-error.vue +0 -6
- package/tests/utils/linter/fixtures/vue/undeclare-variable.vue +0 -6
- package/tests/utils/linter/fixtures/vue/unused-variable.vue +0 -7
- package/tests/utils/linter/fixtures/vue/valid-code.vue +0 -6
- package/tests/utils/linter/fixtures/yaml/keyword-error.yml +0 -1
- package/tests/utils/linter/fixtures/yaml/missing-semicolon.yml +0 -2
- package/tests/utils/linter/fixtures/yaml/syntax-error.yml +0 -1
- package/tests/utils/linter/fixtures/yaml/undeclare-variable.yml +0 -1
- package/tests/utils/linter/fixtures/yaml/unused-variable.yml +0 -2
- package/tests/utils/linter/fixtures/yaml/valid-code.yml +0 -3
- package/tests/utils/linter/index.test.mjs +0 -440
- package/tests/utils/linter/scan-results.mjs +0 -42
- package/tests/utils/load-config.test.mjs +0 -141
- package/tests/utils/markdown/index.test.mjs +0 -478
- package/tests/utils/mermaid-validator.test.mjs +0 -541
- package/tests/utils/mock-chat-model.mjs +0 -12
- package/tests/utils/preferences-utils.test.mjs +0 -465
- package/tests/utils/save-value-to-config.test.mjs +0 -483
- package/tests/utils/utils.test.mjs +0 -941
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# 履歴の管理
|
|
2
|
-
|
|
3
|
-
AIGNE DocSmithは、ドキュメントに加えられたすべての更新の時系列ログを保持します。この機能により、変更を追跡し、更新時に提供されたフィードバックを確認し、時間とともにドキュメントがどのように変化したかを理解できます。このガイドでは、この履歴にアクセスして解釈する方法について説明します。
|
|
4
|
-
|
|
5
|
-
## 更新履歴の表示
|
|
6
|
-
|
|
7
|
-
すべてのドキュメント更新のログを表示するには、`history view` コマンドを使用します。このコマンドは、バージョン管理ログのように、各エントリの簡潔な1行の要約を表示します。
|
|
8
|
-
|
|
9
|
-
ターミナルで次のコマンドを実行してください:
|
|
10
|
-
|
|
11
|
-
```bash 履歴の表示 icon=material-symbols:history
|
|
12
|
-
aigne history view
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
`history` コマンドは、`view` サブコマンドの2つのエイリアス、`log` と `list` もサポートしています。以下のコマンドは同等であり、同じ出力を生成します:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
aigne history log
|
|
19
|
-
aigne history list
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### 履歴出力の理解
|
|
23
|
-
|
|
24
|
-
`history view` コマンドの出力は、各更新に関する主要な情報を一目でわかるようにフォーマットされています。各行は、1つの更新エントリを表します。
|
|
25
|
-
|
|
26
|
-
以下にそのフォーマットの内訳を示します:
|
|
27
|
-
|
|
28
|
-
| コンポーネント | 説明 |
|
|
29
|
-
| :--- | :--- |
|
|
30
|
-
| **Short Hash** | 更新のタイムスタンプから生成される8文字の一意の識別子。 |
|
|
31
|
-
| **Date** | 更新が発生した時期を示す相対的なタイムスタンプ(例:「5 minutes ago」、「2 days ago」)。古いエントリには、特定の日付が表示されます。 |
|
|
32
|
-
| **Operation** | `generate_document` や `update_document_detail` など、実行されたアクションの種類。 |
|
|
33
|
-
| **Document Path** | 操作が単一ファイルを対象とした場合に、変更された特定のドキュメントのパス。これは括弧で囲まれます。 |
|
|
34
|
-
| **Feedback** | 更新が行われたときに提供されたフィードバックまたは要約メッセージ。 |
|
|
35
|
-
|
|
36
|
-
### 例
|
|
37
|
-
|
|
38
|
-
以下は `aigne history view` コマンドを実行した際のサンプル出力です。
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
📜 Update History
|
|
42
|
-
|
|
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.
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
このログは、ドキュメントの変更履歴を明確かつ整理された記録として提供し、進捗の追跡や過去の変更の確認に役立ちます。
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Managing History
|
|
2
|
-
|
|
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
|
-
|
|
5
|
-
## Viewing Update History
|
|
6
|
-
|
|
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
|
-
|
|
9
|
-
Execute the following command in your project's root directory:
|
|
10
|
-
|
|
11
|
-
```bash Viewing History icon=material-symbols:history
|
|
12
|
-
aigne history view
|
|
13
|
-
```
|
|
14
|
-
|
|
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
|
-
|
|
17
|
-
```bash
|
|
18
|
-
aigne history log
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
aigne history list
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
If no updates have been made yet, the tool will display the message: `No update history found`.
|
|
26
|
-
|
|
27
|
-
### Understanding the History Output
|
|
28
|
-
|
|
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.
|
|
30
|
-
|
|
31
|
-
The format is composed of the following components:
|
|
32
|
-
|
|
33
|
-
| Component | Description |
|
|
34
|
-
| :--- | :--- |
|
|
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. |
|
|
40
|
-
|
|
41
|
-
### Example Output
|
|
42
|
-
|
|
43
|
-
Below is a sample output from running the `aigne history view` command. This example illustrates how different operations are recorded in the log.
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
📜 Update History
|
|
47
|
-
|
|
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.
|
|
51
|
-
```
|
|
52
|
-
|
|
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,48 +0,0 @@
|
|
|
1
|
-
# 管理歷史紀錄
|
|
2
|
-
|
|
3
|
-
AIGNE DocSmith 會按時間順序記錄您對文件所做的所有更新。此功能可讓您追蹤變更、檢閱更新期間提供的回饋,並了解文件隨時間的演變過程。本指南將說明如何存取和解讀此歷史紀錄。
|
|
4
|
-
|
|
5
|
-
## 查看更新歷史紀錄
|
|
6
|
-
|
|
7
|
-
若要查看所有文件的更新日誌,您可以使用 `history view` 指令。此指令會為每個項目顯示精簡的單行摘要,類似於版本控制的日誌。
|
|
8
|
-
|
|
9
|
-
在您的終端機中執行以下指令:
|
|
10
|
-
|
|
11
|
-
```bash 查看歷史紀錄 icon=material-symbols:history
|
|
12
|
-
aigne history view
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
`history` 指令也支援 `view` 子指令的兩個別名:`log` 和 `list`。以下指令是等效的,將會產生相同的輸出:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
aigne history log
|
|
19
|
-
aigne history list
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### 了解歷史紀錄輸出
|
|
23
|
-
|
|
24
|
-
`history view` 指令的輸出格式旨在讓您能一目了然地獲取每次更新的關鍵資訊。每一行代表一個單獨的更新項目。
|
|
25
|
-
|
|
26
|
-
以下是其格式的詳細說明:
|
|
27
|
-
|
|
28
|
-
| 元件 | 說明 |
|
|
29
|
-
| :--- | :--- |
|
|
30
|
-
| **簡短雜湊值** | 一個從更新時間戳產生的 8 字元唯一識別碼。 |
|
|
31
|
-
| **日期** | 一個相對時間戳,表示更新發生的時間(例如,「5 分鐘前」、「2 天前」)。對於較舊的項目,則會顯示具體日期。 |
|
|
32
|
-
| **操作** | 執行的操作類型,例如 `generate_document` 或 `update_document_detail`。 |
|
|
33
|
-
| **文件路徑** | 如果操作針對的是單一檔案,則為被修改的特定文件的路徑。此路徑會用括號括起來。 |
|
|
34
|
-
| **回饋** | 進行更新時所提供的回饋或摘要訊息。 |
|
|
35
|
-
|
|
36
|
-
### 範例
|
|
37
|
-
|
|
38
|
-
以下是執行 `aigne history view` 指令的範例輸出。
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
📜 更新歷史紀錄
|
|
42
|
-
|
|
43
|
-
e5a4f8b1 2 小時前 update_document_detail (/guides/generating-documentation): 新增了關於進階設定選項的新章節。
|
|
44
|
-
a3b1c9d2 1 天前 update_document_detail (/overview): 修訂了簡介,使其更加簡潔。
|
|
45
|
-
f8d2e0c3 3 天前 generate_document (/guides/managing-history): 初次產生歷史紀錄管理指南。
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
此日誌提供了您文件修改歷史的清晰有序記錄,有助於追蹤進度和檢閱過去的變更。
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# 管理历史记录
|
|
2
|
-
|
|
3
|
-
AIGNE DocSmith 会为您的文档所做的所有更新保留一份按时间顺序排列的日志。此功能允许您跟踪变更、审查更新期间提供的反馈,并了解文档随时间的演变过程。本指南说明了如何访问和解读此历史记录。
|
|
4
|
-
|
|
5
|
-
## 查看更新历史记录
|
|
6
|
-
|
|
7
|
-
要查看所有文档更新的日志,您可以使用 `history view` 命令。该命令会为每条记录显示一个紧凑的单行摘要,类似于版本控制日志。
|
|
8
|
-
|
|
9
|
-
在您的终端中执行以下命令:
|
|
10
|
-
|
|
11
|
-
```bash 查看历史记录 icon=material-symbols:history
|
|
12
|
-
aigne history view
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
`history` 命令还支持 `view` 子命令的两个别名:`log` 和 `list`。以下命令是等效的,并将产生相同的输出:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
aigne history log
|
|
19
|
-
aigne history list
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### 理解历史记录输出
|
|
23
|
-
|
|
24
|
-
`history view` 命令的输出经过格式化,以便一目了然地提供每次更新的关键信息。每一行代表一条更新记录。
|
|
25
|
-
|
|
26
|
-
以下是其格式的分解说明:
|
|
27
|
-
|
|
28
|
-
| 组件 | 描述 |
|
|
29
|
-
| :--- | :--- |
|
|
30
|
-
| **短哈希值** | 根据更新时间戳生成的 8 位字符唯一标识符。 |
|
|
31
|
-
| **日期** | 一个相对时间戳,表示更新发生的时间(例如,“5 分钟前”、“2 天前”)。对于较早的记录,会显示具体日期。 |
|
|
32
|
-
| **操作** | 执行的操作类型,例如 `generate_document` 或 `update_document_detail`。 |
|
|
33
|
-
| **文档路径** | 如果操作针对单个文件,则为被修改的具体文档的路径。该路径包含在括号中。 |
|
|
34
|
-
| **反馈** | 更新时提供的反馈或摘要信息。 |
|
|
35
|
-
|
|
36
|
-
### 示例
|
|
37
|
-
|
|
38
|
-
以下是运行 `aigne history view` 命令的示例输出。
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
📜 更新历史记录
|
|
42
|
-
|
|
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.
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
此日志为您的文档修改历史提供了清晰有序的记录,有助于跟踪进度和回顾过去的变更。
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
# ドキュメントの公開
|
|
2
|
-
|
|
3
|
-
ドキュメントを生成したら、次のステップはそれをオンラインで公開し、読者がアクセスできるようにすることです。このガイドでは、`aigne doc publish` コマンドを使用した公開プロセスの体系的な概要を説明します。
|
|
4
|
-
|
|
5
|
-
## 公開コマンド
|
|
6
|
-
|
|
7
|
-
ドキュメントを公開するための主要なコマンドは `aigne doc publish` です。このコマンドは、生成されたファイルをウェブサービスにアップロードし、ブラウザで表示できるようにします。
|
|
8
|
-
|
|
9
|
-
このコマンドは、フルネームまたは短いエイリアスで実行できます:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
# フルコマンド
|
|
13
|
-
aigne doc publish
|
|
14
|
-
|
|
15
|
-
# エイリアス
|
|
16
|
-
aigne doc pub
|
|
17
|
-
aigne doc p
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
publish コマンドを初めて実行すると、希望する公開プラットフォームを選択するための対話型プロンプトが表示されます。
|
|
21
|
-
|
|
22
|
-
## 公開オプション
|
|
23
|
-
|
|
24
|
-
ドキュメントをホストする場所にはいくつかのオプションがあります。対話型プロンプトが選択をガイドします。
|
|
25
|
-
|
|
26
|
-
### 1. DocSmith Cloud(無料ホスティング)
|
|
27
|
-
|
|
28
|
-
このオプションは、AIGNE が提供する無料のホスティングサービスである `docsmith.aigne.io` にドキュメントを公開します。
|
|
29
|
-
|
|
30
|
-
- **ユースケース:** オープンソースプロジェクト、個人ブログなど、カスタムインフラを必要とせず公開アクセスが必要なあらゆるシナリオに最適です。
|
|
31
|
-
- **コスト:** 無料。
|
|
32
|
-
- **結果:** 公開が成功すると、提供された URL でドキュメントが公開されます。
|
|
33
|
-
|
|
34
|
-
### 2. 既存のウェブサイト
|
|
35
|
-
|
|
36
|
-
このオプションを使用すると、すでに所有および管理しているウェブサイトにドキュメントを公開できます。
|
|
37
|
-
|
|
38
|
-
- **ユースケース:** 既存の会社のウェブサイト、製品サイト、または個人ドメインにドキュメントを直接統合する場合に最適です。この方法では、Discuss Kit の独自のインスタンスを実行する必要があります。
|
|
39
|
-
- **コスト:** 独自のホスティングインフラが必要です。
|
|
40
|
-
- **セットアップ:**
|
|
41
|
-
1. プロンプトでこのオプションを選択します。
|
|
42
|
-
2. ウェブサイトの URL を入力するよう求められます(例:`https://docs.your-company.com`)。
|
|
43
|
-
3. 独自のドキュメントウェブサイトをセットアップするには、公式ストアから Discuss Kit インスタンスを入手できます:[https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit)。
|
|
44
|
-
|
|
45
|
-
### 3. 新規ウェブサイト(有料サービス)
|
|
46
|
-
|
|
47
|
-
既存のウェブサイトがない場合、このサービスはドキュメント専用の新しいサイトをセットアップするのに役立ちます。
|
|
48
|
-
|
|
49
|
-
- **ユースケース:** カスタムドメインと管理されたホスティングを備えた、プロフェッショナルでスタンドアロンのドキュメントポータルを作成するのに適しています。
|
|
50
|
-
- **コスト:** これは有料サービスです。
|
|
51
|
-
- **プロセス:** コマンドは、新しい Discuss Kit インスタンスのデプロイと設定に必要な手順をガイドします。このプロセスを以前に開始したことがある場合は、以前のセットアップを再開するオプションも表示されます。
|
|
52
|
-
|
|
53
|
-
## 直接公開
|
|
54
|
-
|
|
55
|
-
CI/CD パイプラインなどの自動化されたワークフローの場合、または初期設定が完了した後は、アプリケーションの URL を直接指定することで対話型プロンプトをバイパスできます。
|
|
56
|
-
|
|
57
|
-
`--appUrl` フラグに続けてウェブサイトの URL を指定します。
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
# カスタムドキュメントサイトの例
|
|
61
|
-
aigne doc publish --appUrl https://docs.your-company.com
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
特定の URL への公開に成功すると(プロンプトでオプションを選択するか、`--appUrl` フラグを使用するかのいずれか)、DocSmith はこの URL をローカル設定に保存します。次回以降の実行時には、再度尋ねることなく、保存された URL に自動的に公開します。
|
|
65
|
-
|
|
66
|
-
## トラブルシューティング
|
|
67
|
-
|
|
68
|
-
### 認証エラー
|
|
69
|
-
|
|
70
|
-
「401」または「403」を含むエラーメッセージが表示された場合、認証トークンが無効であるか、期限切れであることを示します。これは、権限が変更された場合や、トークンが古い場合に発生する可能性があります。
|
|
71
|
-
|
|
72
|
-
これを解決するには、`clear` コマンドを実行して、保存されているすべての設定と認証情報をクリアします:
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
aigne doc clear
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
設定をクリアした後、再度 `aigne doc publish` を実行してください。初めて実行したときのように、認証とセットアップのプロセスがガイドされます。
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
# Publishing Your Docs
|
|
2
|
-
|
|
3
|
-
After generating your documentation, the next step is to make it accessible online. This guide provides a systematic procedure for publishing your documentation using the `aigne doc publish` command.
|
|
4
|
-
|
|
5
|
-
## The Publish Command
|
|
6
|
-
|
|
7
|
-
The `aigne doc publish` command uploads your generated documentation files to a web service, making them available to your audience through a web browser.
|
|
8
|
-
|
|
9
|
-
You can execute the command using its full name or one of its aliases for convenience.
|
|
10
|
-
|
|
11
|
-
```bash Command Execution icon=lucide:terminal
|
|
12
|
-
# Full command
|
|
13
|
-
aigne doc publish
|
|
14
|
-
|
|
15
|
-
# Aliases
|
|
16
|
-
aigne doc pub
|
|
17
|
-
aigne doc p
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
When this command is run for the first time, it initiates an interactive prompt to guide you through selecting a publishing platform.
|
|
21
|
-
|
|
22
|
-

|
|
23
|
-
|
|
24
|
-
## Publishing Destinations
|
|
25
|
-
|
|
26
|
-
The tool provides several destinations for hosting your documentation. The interactive setup will present the following choices.
|
|
27
|
-
|
|
28
|
-
### Option 1: DocSmith Cloud
|
|
29
|
-
|
|
30
|
-
This option publishes your documentation to `docsmith.aigne.io`, a free hosting service.
|
|
31
|
-
|
|
32
|
-
* **Intended Use**: This method is suitable for open-source projects or any documentation that is intended for public access.
|
|
33
|
-
* **Cost**: Free.
|
|
34
|
-
* **Outcome**: Your documentation will be publicly available at a URL provided after the publishing process is complete.
|
|
35
|
-
|
|
36
|
-
### Option 2: Your Existing Website
|
|
37
|
-
|
|
38
|
-
This option allows you to publish documentation to a website you already own and manage. It requires you to operate your own instance of Discuss Kit.
|
|
39
|
-
|
|
40
|
-
* **Intended Use**: This is for integrating documentation directly into an existing company website, product portal, or personal domain.
|
|
41
|
-
* **Requirements**: You must have your own hosting infrastructure and a running instance of Discuss Kit.
|
|
42
|
-
* **Procedure**:
|
|
43
|
-
1. Select the "Your existing website" option from the interactive prompt.
|
|
44
|
-
2. When prompted, enter the full URL of your website (e.g., `https://docs.your-company.com`).
|
|
45
|
-
3. To set up your own documentation website, you can obtain a Discuss Kit instance from the official store: [https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit). Discuss Kit is a non-open-source service that provides the necessary backend for hosting.
|
|
46
|
-
|
|
47
|
-
### Option 3: New Website
|
|
48
|
-
|
|
49
|
-
This option assists you in setting up a new, dedicated website for your documentation.
|
|
50
|
-
|
|
51
|
-
* **Intended Use**: This is for users who need a standalone documentation portal but do not have an existing website.
|
|
52
|
-
* **Cost**: This is a paid service.
|
|
53
|
-
* **Procedure**: The command-line interface will guide you through the process of deploying and configuring a new Discuss Kit instance. If you have previously started this process, an option to resume the setup will also be available.
|
|
54
|
-
|
|
55
|
-
## Automated Publishing
|
|
56
|
-
|
|
57
|
-
For automated environments, such as a Continuous Integration/Continuous Deployment (CI/CD) pipeline, you can bypass the interactive prompt by specifying the destination URL directly.
|
|
58
|
-
|
|
59
|
-
Use the `--appUrl` flag with the command to define the publishing target.
|
|
60
|
-
|
|
61
|
-
```bash Direct Publishing Example icon=lucide:terminal
|
|
62
|
-
aigne doc publish --appUrl https://docs.your-company.com
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Once you publish to a specific URL for the first time (either through the interactive prompt or the `--appUrl` flag), the tool saves this URL to your local configuration file. Subsequent executions of `aigne doc publish` will automatically use the saved URL, streamlining the update process.
|
|
66
|
-
|
|
67
|
-
## Troubleshooting
|
|
68
|
-
|
|
69
|
-
### Authorization Errors
|
|
70
|
-
|
|
71
|
-
If the publishing process fails with an error message that includes "401" or "403," it signifies an issue with your authentication token. The token may be invalid, expired, or lack the required permissions.
|
|
72
|
-
|
|
73
|
-
To resolve this, reset your local configuration and credentials by running the `clear` command:
|
|
74
|
-
|
|
75
|
-
```bash Clear Configuration icon=lucide:terminal
|
|
76
|
-
aigne doc clear
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
After the command completes, run `aigne doc publish` again. You will be prompted to re-authenticate and configure your publishing destination.
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
After successfully publishing your documentation, you may need to update it as your project evolves. For instructions on this process, please see the [Updating Documentation](./guides-updating-documentation.md) guide.
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
# 發布您的文件
|
|
2
|
-
|
|
3
|
-
產生文件後,下一步就是將其發布到網路上,讓您的受眾可以存取。本指南將系統性地介紹如何使用 `aigne doc publish` 命令來進行發布流程。
|
|
4
|
-
|
|
5
|
-
## 發布命令
|
|
6
|
-
|
|
7
|
-
讓您的文件上線的主要命令是 `aigne doc publish`。此命令會將您產生的檔案上傳到網路服務,以便在瀏覽器中查看。
|
|
8
|
-
|
|
9
|
-
您可以使用其完整名稱或較短的別名來執行此命令:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
# 完整命令
|
|
13
|
-
aigne doc publish
|
|
14
|
-
|
|
15
|
-
# 別名
|
|
16
|
-
aigne doc pub
|
|
17
|
-
aigne doc p
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
當您首次執行發布命令時,系統會顯示一個互動式提示,讓您選擇偏好的發布平台。
|
|
21
|
-
|
|
22
|
-
## 發布選項
|
|
23
|
-
|
|
24
|
-
您有多個選項來託管您的文件。互動式提示將引導您完成選擇。
|
|
25
|
-
|
|
26
|
-
### 1. DocSmith Cloud (免費託管)
|
|
27
|
-
|
|
28
|
-
此選項會將您的文件發布到 `docsmith.aigne.io`,這是由 AIGNE 提供的免費託管服務。
|
|
29
|
-
|
|
30
|
-
- **使用情境:** 非常適合開源專案、個人部落格,或任何希望在無需自訂基礎設施的情況下實現公開存取的場景。
|
|
31
|
-
- **成本:** 免費。
|
|
32
|
-
- **結果:** 成功發布後,您的文件將可透過一個提供的 URL 公開存取。
|
|
33
|
-
|
|
34
|
-
### 2. 您現有的網站
|
|
35
|
-
|
|
36
|
-
此選項讓您可以將文件發布到您已擁有並管理的網站。
|
|
37
|
-
|
|
38
|
-
- **使用情境:** 最適合將文件直接整合到現有的公司網站、產品網站或個人網域。此方法需要您執行自己的 Discuss Kit 實例。
|
|
39
|
-
- **成本:** 需要您自己的託管基礎設施。
|
|
40
|
-
- **設定:**
|
|
41
|
-
1. 在提示中選擇此選項。
|
|
42
|
-
2. 系統會要求您輸入網站的 URL (例如:`https://docs.your-company.com`)。
|
|
43
|
-
3. 若要設定您自己的文件網站,您可以從官方商店取得 Discuss Kit 實例:[https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit)。
|
|
44
|
-
|
|
45
|
-
### 3. 新網站 (付費服務)
|
|
46
|
-
|
|
47
|
-
如果您沒有現成的網站,此服務可協助您為文件建立一個新的專屬網站。
|
|
48
|
-
|
|
49
|
-
- **使用情境:** 適合用於建立一個專業、獨立的文件入口網站,並為您管理自訂網域和託管。
|
|
50
|
-
- **成本:** 此為付費服務。
|
|
51
|
-
- **流程:** 此命令將引導您完成部署和設定新 Discuss Kit 實例的必要步驟。如果您之前已開始此流程,您也會看到一個選項來繼續先前的設定。
|
|
52
|
-
|
|
53
|
-
## 直接發布
|
|
54
|
-
|
|
55
|
-
對於自動化工作流程 (例如 CI/CD 管線),或在您完成初始設定後,您可以透過直接指定應用程式 URL 來繞過互動式提示。
|
|
56
|
-
|
|
57
|
-
使用 `--appUrl` 旗標,並在後面加上您網站的 URL。
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
# 自訂文件網站的範例
|
|
61
|
-
aigne doc publish --appUrl https://docs.your-company.com
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
一旦您成功發布到特定 URL (無論是透過在提示中選擇選項或使用 `--appUrl` 旗標),DocSmith 會將此 URL 儲存在您的本機設定中。在後續執行時,它將自動發布到已儲存的 URL,而不會再次詢問。
|
|
65
|
-
|
|
66
|
-
## 疑難排解
|
|
67
|
-
|
|
68
|
-
### 授權錯誤
|
|
69
|
-
|
|
70
|
-
如果您遇到包含「401」或「403」的錯誤訊息,這表示您的驗證權杖無效或已過期。如果權限已變更或權杖過舊,就可能發生這種情況。
|
|
71
|
-
|
|
72
|
-
要解決此問題,您可以執行 `clear` 命令來清除所有儲存的設定和憑證:
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
aigne doc clear
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
清除設定後,再次執行 `aigne doc publish`。系統將引導您完成驗證和設定流程,就像第一次執行一樣。
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
# 发布您的文档
|
|
2
|
-
|
|
3
|
-
生成文档后,下一步是将其发布到线上,以便您的受众可以访问。本指南系统地概述了使用 `aigne doc publish` 命令的发布过程。
|
|
4
|
-
|
|
5
|
-
## 发布命令
|
|
6
|
-
|
|
7
|
-
`aigne doc publish` 是用于上线文档的主要命令。该命令会将您生成的文件上传到 Web 服务,以便在浏览器中查看。
|
|
8
|
-
|
|
9
|
-
您可以使用其完整名称或更短的别名来执行该命令:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
# 完整命令
|
|
13
|
-
aigne doc publish
|
|
14
|
-
|
|
15
|
-
# 别名
|
|
16
|
-
aigne doc pub
|
|
17
|
-
aigne doc p
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
当您首次运行发布命令时,系统将显示一个交互式提示,让您选择首选的发布平台。
|
|
21
|
-
|
|
22
|
-
## 发布选项
|
|
23
|
-
|
|
24
|
-
您有多种托管文档的选项。交互式提示将引导您完成选择。
|
|
25
|
-
|
|
26
|
-
### 1. DocSmith Cloud(免费托管)
|
|
27
|
-
|
|
28
|
-
此选项会将您的文档发布到 `docsmith.aigne.io`,这是 AIGNE 提供的免费托管服务。
|
|
29
|
-
|
|
30
|
-
- **用例:** 非常适合开源项目、个人博客或任何希望在无需自定义基础设施的情况下实现公开访问的场景。
|
|
31
|
-
- **成本:** 免费。
|
|
32
|
-
- **结果:** 您的文档将在发布成功后通过提供的 URL 公开访问。
|
|
33
|
-
|
|
34
|
-
### 2. 您现有的网站
|
|
35
|
-
|
|
36
|
-
此选项允许您将文档发布到您已拥有并管理的网站。
|
|
37
|
-
|
|
38
|
-
- **用例:** 最适合将文档直接集成到现有公司网站、产品站点或个人域名中。此方法需要您运行自己的 Discuss Kit 实例。
|
|
39
|
-
- **成本:** 需要您自己的托管基础设施。
|
|
40
|
-
- **设置:**
|
|
41
|
-
1. 在提示中选择此选项。
|
|
42
|
-
2. 系统会要求您输入网站的 URL(例如,`https://docs.your-company.com`)。
|
|
43
|
-
3. 要设置您自己的文档网站,您可以从官方商店获取 Discuss Kit 实例:[https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit)。
|
|
44
|
-
|
|
45
|
-
### 3. 新网站(付费服务)
|
|
46
|
-
|
|
47
|
-
如果您没有现有网站,此服务可以帮助您为文档建立一个新的专用站点。
|
|
48
|
-
|
|
49
|
-
- **用例:** 适合创建具有自定义域名和托管服务的专业、独立的文档门户。
|
|
50
|
-
- **成本:** 这是一项付费服务。
|
|
51
|
-
- **流程:** 该命令将引导您完成部署和配置新的 Discuss Kit 实例所需的步骤。如果您之前已开始此过程,您还会看到一个恢复先前设置的选项。
|
|
52
|
-
|
|
53
|
-
## 直接发布
|
|
54
|
-
|
|
55
|
-
对于自动化工作流(如 CI/CD 管道),或在您完成初始设置后,您可以通过直接指定应用程序 URL 来绕过交互式提示。
|
|
56
|
-
|
|
57
|
-
使用 `--appUrl` 标志,后跟您的网站 URL。
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
# 自定义文档站点示例
|
|
61
|
-
aigne doc publish --appUrl https://docs.your-company.com
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
当您成功发布到特定 URL(通过在提示中选择选项或使用 `--appUrl` 标志)后,DocSmith 会将此 URL 保存在您的本地配置中。在后续运行中,它将自动发布到已保存的 URL,而不会再次询问。
|
|
65
|
-
|
|
66
|
-
## 问题排查
|
|
67
|
-
|
|
68
|
-
### 授权错误
|
|
69
|
-
|
|
70
|
-
如果您遇到包含“401”或“403”的错误消息,这表示您的身份验证令牌无效或已过期。如果权限已更改或令牌过旧,可能会发生这种情况。
|
|
71
|
-
|
|
72
|
-
要解决此问题,您可以运行 `clear` 命令来清除所有存储的配置和凭据:
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
aigne doc clear
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
清除配置后,再次运行 `aigne doc publish`。系统将引导您完成身份验证和设置过程,就像第一次一样。
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
# ドキュメントの翻訳
|
|
2
|
-
|
|
3
|
-
このガイドでは、`aigne doc translate` コマンドを使用して、生成されたドキュメントを多言語に翻訳する方法について説明します。このプロセスでは AI を使用して、翻訳が文脈を認識し、技術的な正確性を維持するようにします。
|
|
4
|
-
|
|
5
|
-
このツールは12の言語をサポートしており、世界中のオーディエンスにリーチすることができます。ソースドキュメントの主要言語は、利用可能な翻訳言語のリストから自動的に除外されます。
|
|
6
|
-
|
|
7
|
-
## `translate` コマンド
|
|
8
|
-
|
|
9
|
-
`aigne doc translate` コマンドは、既存のドキュメントファイルの翻訳を生成するために使用されます。対話形式で実行して、翻訳したいドキュメントと言語を選択することも、自動化されたワークフローのためにコマンドラインフラグを使用してこれらのオプションを直接指定することもできます。
|
|
10
|
-
|
|
11
|
-
### 対話モード
|
|
12
|
-
|
|
13
|
-
ガイド付きのエクスペリエンスを利用するには、引数なしでコマンドを実行します。
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
aigne doc translate
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
実行されると、ツールは以下の手順を実行します。
|
|
20
|
-
1. 既存のドキュメントをスキャンします。
|
|
21
|
-
2. リストから翻訳したい特定のドキュメントを選択するように求めます。
|
|
22
|
-
3. 翻訳の対象言語を選択するように求めます。以前に選択した言語は、便宜上、事前にチェックされています。
|
|
23
|
-
4. 選択された各ドキュメントと言語のペアに対して翻訳プロセスを開始します。
|
|
24
|
-
5. 翻訳されたファイルを同じディレクトリに保存します。新しいファイルは、元のファイル名に言語コードを追加して命名されます(例:`overview.md` の中国語翻訳は `overview.zh.md` になります)。
|
|
25
|
-
|
|
26
|
-
### コマンドラインオプション
|
|
27
|
-
|
|
28
|
-
非対話的な使用やスクリプト作成のために、以下のコマンドラインフラグを使用して翻訳プロセスを制御できます。
|
|
29
|
-
|
|
30
|
-
<x-field-group>
|
|
31
|
-
<x-field data-name="--docs" data-type="array<string>">
|
|
32
|
-
<x-field-desc markdown>翻訳する1つ以上のドキュメントパスを指定します。指定しない場合、ツールは対話モードに入り、利用可能なドキュメントのリストから選択できるようになります。</x-field-desc>
|
|
33
|
-
</x-field>
|
|
34
|
-
<x-field data-name="--langs" data-type="array<string>">
|
|
35
|
-
<x-field-desc markdown>1つ以上のターゲット言語コード(例:`zh`、`ja`)を指定します。省略した場合、対話形式で言語を選択するように求められます。</x-field-desc>
|
|
36
|
-
</x-field>
|
|
37
|
-
<x-field data-name="--glossary" data-type="string">
|
|
38
|
-
<x-field-desc markdown>用語集ファイルへのパス(例:`@path/to/glossary.md`)を提供します。これにより、特定の技術用語がすべてのドキュメントで一貫して翻訳されるようになります。</x-field-desc>
|
|
39
|
-
</x-field>
|
|
40
|
-
<x-field data-name="--feedback" data-type="string">
|
|
41
|
-
<x-field-desc markdown>トーンや用語の調整など、AIの翻訳スタイルをガイドするための具体的な指示やフィードバックを提供します。</x-field-desc>
|
|
42
|
-
</x-field>
|
|
43
|
-
</x-field-group>
|
|
44
|
-
|
|
45
|
-
### 使用例
|
|
46
|
-
|
|
47
|
-
#### 1. 特定のドキュメントを複数の言語に翻訳する
|
|
48
|
-
|
|
49
|
-
対話プロンプトなしで `overview.md` と `examples.md` を中国語(`zh`)と日本語(`ja`)に翻訳するには:
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
#### 2. 用語集を使用して一貫した用語を確保する
|
|
56
|
-
|
|
57
|
-
技術用語が正しく翻訳されるように、用語集ファイルを提供します。これは、ブランド名や専門用語の一貫性を維持するのに役立ちます。
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
aigne doc translate --glossary @./glossary.md
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
#### 3. フィードバックを提供して翻訳スタイルを洗練させる
|
|
64
|
-
|
|
65
|
-
フィードバックを提供することで、翻訳スタイルをガイドできます。例えば、よりフォーマルなトーンをリクエストするには:
|
|
66
|
-
|
|
67
|
-
```bash
|
|
68
|
-
aigne doc translate --feedback "Use a formal, technical tone for all translations."
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
このフィードバックは、更新されたドキュメントの履歴に記録されます。
|
|
72
|
-
|
|
73
|
-
## サポートされている言語
|
|
74
|
-
|
|
75
|
-
このツールは12言語の翻訳をサポートしています。ドキュメントのネイティブ言語は英語(`en`)です。
|
|
76
|
-
|
|
77
|
-
| 言語 | コード |
|
|
78
|
-
| :--- | :--- |
|
|
79
|
-
| 中国語(簡体字) | `zh` |
|
|
80
|
-
| 中国語(繁体字)| `zh-TW`|
|
|
81
|
-
| 日本語 | `ja` |
|
|
82
|
-
| 韓国語 | `ko` |
|
|
83
|
-
| スペイン語 | `es` |
|
|
84
|
-
| フランス語 | `fr` |
|
|
85
|
-
| ドイツ語 | `de` |
|
|
86
|
-
| ポルトガル語 | `pt` |
|
|
87
|
-
| ロシア語 | `ru` |
|
|
88
|
-
| イタリア語 | `it` |
|
|
89
|
-
| アラビア語 | `ar` |
|
|
90
|
-
|
|
91
|
-
## 概要
|
|
92
|
-
|
|
93
|
-
`translate` コマンドは、ドキュメントをローカライズするための構造化された方法を提供します。対話モードを使用してガイド付きの翻訳を行ったり、コマンドラインオプションを使用して自動化されたワークフローを構築したりできます。用語集やフィードバックなどの機能を使用することで、翻訳コンテンツの品質と一貫性を維持するのに役立ちます。
|
|
94
|
-
|
|
95
|
-
ドキュメントを翻訳した後、[ドキュメントの公開](./guides-publishing-your-docs.md)に進むことができます。
|