update wiki

SwanHubX · Jun 17, 2024 · 7409363 · 7409363
1 parent 46a6b56
commit 7409363
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/.github/workflows/update-wiki.yml b/.github/workflows/update-wiki.yml
@@ -28,7 +28,7 @@ jobs:
 
       - name: Run parser
         run: |
-          python3 scripts/parse_docs.py docs/
+          python3 scripts/parse_docs.py docs/wiki/
 
       # 1. Create folder named `tmp_wiki`
       # 2. Initialize Git

diff --git a/docs/Home.md b/docs/Home.md
diff --git a/docs/Unit-Test.md b/docs/Unit-Test.md
diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md
@@ -0,0 +1,11 @@
+欢迎来到SwanLab-Toolkit wiki！SwanLab-Toolkit是为[SwanLab](https://github.com/SwanHubX/SwanLab)
+定制的工具软件包，初衷是为了更好的维护和管理SwanLab。
+
+在本wiki，你可以查阅到当前本仓库提供的一些API功能，帮助开发和维护SwanLab。
+如果你希望更好的了解本仓库，可以查看swankit的[源码](https://github.com/SwanHubX/SwanLab-Toolkit)
+
+>
+出于一些考虑，本wiki只收录API的使用方法，如果需要查看更详细的文档，建议移步[docs](https://github.com/SwanHubX/SwanLab-Toolkit/tree/main/docs)
+
+
+