Docs (#125)

* Fix contents. * Fix doc titles.
Ai00-X · May 24, 2024 · 720569e · 720569e
1 parent a14ea60
commit 720569e
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 24 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -7,17 +7,17 @@ export default defineConfig({
   base: '/ai00_server/',
   lastUpdated: true,
   cleanUrls: true,
-  appearance:'dark',
+  appearance: 'dark',
   markdown: {
     math: true
   },
- 
+
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     search: {
       provider: 'local'
     },
-   socialLinks: [
+    socialLinks: [
       { icon: 'github', link: 'https://github.com/Ai00-X/ai00_server' }
     ],
 
@@ -50,14 +50,15 @@ export default defineConfig({
             base: '/doc-guide/',
             items: [
               { text: '了解 Ai00', link: '/what-is-ai00' },
-              { text: '快速上手', 
+              {
+                text: '快速上手',
                 collapsed: false,
                 items: [
 
-                      { text: '下载编译包', link: '/release' },
-                      { text: '从源码安装', link: '/source-install' },
-                      { text: '配置文件', link: '/config' },
-                  
+                  { text: '下载编译包', link: '/release' },
+                  { text: '从源码安装', link: '/source-install' },
+                  { text: '配置文件', link: '/config' },
+
                 ]
               },
             ]
@@ -70,22 +71,22 @@ export default defineConfig({
             items: [
               { text: '模型命名规范', link: '/models-name' },
               { text: 'RWKV基座模型', link: '/rwkv-base' },
-              { text: 'LoRA模型', link: '/lora-model' },
-              { text: 'State模型', link: '/state-model' },
+              { text: 'LoRA', link: '/lora-model' },
+              { text: '初始State', link: '/state-model' },
             ]
-          } 
+          }
           ,
           {
             text: 'WebUI',
             collapsed: false,
             base: '/doc-webui/',
             items: [
               { text: 'WebUI配置', link: '/webui-config' },
-              { text: 'chat例子', link: '/example-chat' },
-              { text: 'write例子', link: '/example-write' },
+              { text: '对话例子', link: '/example-chat' },
+              { text: '续写例子', link: '/example-write' },
               { text: '并发例子', link: '/example-batch' },
             ]
-          } 
+          }
           ,
           {
             text: 'API',
@@ -94,7 +95,7 @@ export default defineConfig({
             items: [
               { text: 'API接口列表', link: '/openai' },
               { text: '调试API', link: '/debug-api' },
-              { 
+              {
                 text: 'SDK调用',
                 base: 'sdk/',
                 collapsed: false,
@@ -128,6 +129,6 @@ export default defineConfig({
       // other locale specific properties...
     }
   }
- 
+
 
 })
diff --git a/docs/doc-api/debug-api.md b/docs/doc-api/debug-api.md
@@ -1,3 +1,3 @@
 # Debug API
 
-This API is used for debugging purposes.
+This API is used for debugging.
diff --git a/docs/doc-api/openai.md b/docs/doc-api/openai.md
@@ -1 +1 @@
-#openai
+# OpenAI API
diff --git a/docs/doc-models/lora-model.md b/docs/doc-models/lora-model.md
@@ -1,3 +1,3 @@
-# LoRA 模型
+# LoRA
 
 ## 介绍
diff --git a/docs/doc-models/state-model.md b/docs/doc-models/state-model.md
@@ -1 +1 @@
-# State 模型
+# 初始State
diff --git a/docs/doc-webui/example-batch.md b/docs/doc-webui/example-batch.md
@@ -1 +1 @@
-# Example Batch
+# 并发例子
diff --git a/docs/doc-webui/example-chat.md b/docs/doc-webui/example-chat.md
@@ -1 +1 @@
-# example  chat
+# 对话例子
diff --git a/docs/doc-webui/example-write.md b/docs/doc-webui/example-write.md
@@ -1 +1 @@
-# example-write
+# 续写例子
diff --git a/docs/doc-webui/webui-config.md b/docs/doc-webui/webui-config.md
@@ -1 +1 @@
-# WEBUI CONFIG
+# WebUI配置