From 4e0294fb4c429cbb3264cdab56f85f36840ab13f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=B4=9B=E7=AB=B9?= <youngjuning@aliyun.com>
Date: Mon, 16 Aug 2021 23:28:49 +0800
Subject: [PATCH] chore: update docs

---
 README.md    | 40 ++++++++++++++++++++++++++++++++++------
 package.json |  5 +++--
 typedoc.json |  2 +-
 vscode.d.ts  |  1 +
 4 files changed, 39 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 94de7137..e90e5a23 100644
--- a/README.md
+++ b/README.md
@@ -8,23 +8,51 @@ VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaS
 
 API 列表使用 Typedoc 从 [vscode.d.ts](https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts) 文件编译而来，如果 [vscode.d.ts 源文件](https://github.com/microsoft/vscode/blob/main/src/vs/vscode.d.ts) 有更新，我们会及时同步，当前对应 commit 为 [2974a01](https://github.com/microsoft/vscode/commit/2974a014fd33f4a109aad6ed0f3e46fe93bfc794#diff-f127724f8c5dbf0c8371ad0a100f8a9bc0a398b6b8ec29aa6cd7f265bd01a096)。
 
-## 开发
+## 贡献指南
 
-### 安装依赖
+**1、安装依赖**
 
 ```sh
 $ yarn install
 ```
 
-### 调试
+**2、开启调试**
 
 ```sh
 $ yarn dev
 ```
 
-## Contributors ✨
+**3、开启服务**
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+```sh
+$ yarn start
+```
+
+**4、参与翻译**
+
+外部译者对 vscode.d.ts 文件的注释进行翻译，然后提交 PR 即可。申请成为内部译者需要负责某一具体模块，感兴趣请添加管理员微信（`yang_jun_ning`）。
+
+## 负责人
+
+翻译负责人是按照 vscode api 的命名空间认领的，如果有兴趣认领请添加管理员微信（`yang_jun_ning`）申请成为内部译者。
+
+- [ ] authentication
+- [x] commands          @Imchenlong
+- [ ] comments
+- [ ] debug
+- [x] evn               @Saber2pr
+- [ ] extensions
+- [ ] languages
+- [ ] notebooks
+- [ ] scm
+- [ ] tasks
+- [x] tests             @pan463859
+- [x] window            @youngjuning
+- [x] workspace         @gepingli
+
+## 贡献者 ✨
+
+感谢这些优秀的人 ([emoji key](https://allcontributors.org/docs/en/emoji-key))：
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
@@ -44,4 +72,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+本项目遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范。欢迎任何形式的贡献!
diff --git a/package.json b/package.json
index 2f7fc9b3..539f7682 100644
--- a/package.json
+++ b/package.json
@@ -5,7 +5,8 @@
   "scripts": {
     "prebuild": "rimraf docs/",
     "build": "typedoc",
-    "dev": "yarn build --watch & yarn serve docs/"
+    "dev": "yarn build --watch",
+    "start": "serve docs/"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",
@@ -13,4 +14,4 @@
     "typedoc": "^0.21.5",
     "typescript": "^4.3.5"
   }
-}
\ No newline at end of file
+}
diff --git a/typedoc.json b/typedoc.json
index bbc7701b..f6324aa2 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -3,7 +3,7 @@
   "entryPoints": ["./vscode.d.ts"],
   "theme": "./theme",
   "out": "docs",
-  "readme": "none",
+  "readme": "./README.md",
   "sort": ["source-order"],
   "excludePrivate": true,
   "excludeProtected": true,
diff --git a/vscode.d.ts b/vscode.d.ts
index 37171f1b..02fc8575 100644
--- a/vscode.d.ts
+++ b/vscode.d.ts
@@ -8441,6 +8441,7 @@ export interface UriHandler {
 
 /**
  * 用于处理编辑器当前窗口的命名空间。就是可见和活动的编辑器，以及显示信息、选择和要求用户输入的 UI 元素。
+ * @maintainer youngjuning
  */
 export namespace window {