更新开发手册 (#123)

* 更新开发手册 * typo
nezhahq · Dec 10, 2024 · fff0d2a · fff0d2a
1 parent 9ae82fe
commit fff0d2a
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 44 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -299,8 +299,8 @@ function getDeveloperSidebarEnUS() {
     {
       text: 'Development Manual',
       items: [
-        { text: 'Create a new theme', link: '/en_US/developer/theme.html' },
-        { text: 'l10n', link: '/en_US/developer/l10n.html' }
+        { text: 'API documentation', link: '/en_US/developer/api.html' },
+        { text: 'i18n', link: '/en_US/developer/i18n.html' }
       ]
     }
   ]

diff --git a/docs/developer/i18n.md b/docs/developer/i18n.md
@@ -2,16 +2,6 @@
 
 ## 介绍
 
-哪吒使用 [gettext](https://en.wikipedia.org/wiki/Gettext) 进行 i18n，请确保你对 `gettext` 有一定了解。
+[可以在 Hosted Weblate 上参与哪吒的 i18n 工作。](https://hosted.weblate.org/engage/nezha/)
 
-请使用美国英语编写原始文本。
-
-如需添加新的文本，请遵循以下步骤：
-
-0. 确保使用支持的翻译函数，比如 `Localizer.T`。
-1. 运行 `./script/i18n.sh generate template` 生成新模板。
-2. 由于 `en_US` 文本不再需要翻译，运行 `./script/i18n.sh generate en` 生成 `en_US` 文本。
-3. 运行 `./script/i18n.sh update` 更新所有区域的文本。
-4. 编辑各个区域的 `nezha.po` 文件，之后运行 `./script/i18n.sh compile` 编译 `mo` 文件。
-
-也可以使用诸如 `Poedit` 等翻译软件来操作，它们更加方便且几乎不需要命令行操作。
+目前仅覆盖了管理前端和 Dashboard，用户前端 i18n 请根据原仓库提供的步骤进行。
diff --git a/docs/en_US/developer/api.md b/docs/en_US/developer/api.md
@@ -0,0 +1,10 @@
+# API Documentation
+
+A bundled generated API documentation is available in Nezha Dashboard.
+
+## Usage
+
+1. Clone the `master` branch of `https://github.com/nezhahq/nezha.git`.
+2. Run `./script/bootstrap.sh` to generate swagger files.
+3. Compile. If there are missing frontend files, you can bypass it by creating empty files.
+4. Enable `debug` in your Dashboard configuration, the program will print the documentation URL on startup.
diff --git a/docs/en_US/developer/i18n.md b/docs/en_US/developer/i18n.md
@@ -0,0 +1,7 @@
+# i18n
+
+## Introduction
+
+You can engage in the i18n work of Nezha on [Hosted Weblate](https://hosted.weblate.org/engage/nezha/).
+
+Currently, only the admin frontend and Dashboard are covered. The i18n work for the user frontend should follow the steps provided in the original repository.
diff --git a/docs/en_US/developer/index.md b/docs/en_US/developer/index.md
@@ -11,5 +11,5 @@ hero:
   actions:
     - theme: brand
       text: Start Now →
-      link: /en_US/developer/theme
+      link: /en_US/developer/api
 ---
diff --git a/docs/en_US/developer/l10n.md b/docs/en_US/developer/l10n.md
diff --git a/docs/en_US/developer/theme.md b/docs/en_US/developer/theme.md