From f3dce1c2293aa6f7be87498a98f8dd1b906d3e77 Mon Sep 17 00:00:00 2001 From: Arthur Morgan <4637240+badO1a5A90@users.noreply.github.com> Date: Thu, 30 Sep 2021 01:31:24 +0800 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b1dfec0b3..0da0b0c19 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# Xray-docs-next +# project X 的文档网站 + +## 关于网站 + +### 网站内容 + +网站包含了 [project X 文档网站](https://xtls.github.io/) 所呈现的所有内容. + +## 帮助我们改进网站 + +### 改进网站内容 + +- 您可以通过修改本仓库的文档, 帮助我们改进 [project X 文档网站](https://xtls.github.io/) 所呈现的内容. + +- 您可以按 目录与主菜单对应关系 找到已经存在的文档进行修改, 或把您新增的文档放置到相关的目录中. + +- 当您新增或修改完成后, 提交您的修改, 并且向本仓库发出 PR. + +### 自动构建 + +当成功向仓库提交了修改或 PR 被 merge 后, 会自动重新构建 [project X 文档网站](https://xtls.github.io/) + +只需稍等片刻,就可以在网站上看到修改的最新呈现. + +## 致谢 +- 每一位帮助我们改进文档的朋友!