Xray-docs-next/docs/document/document.md

1018 B

改进文档

Project X 的文档托管在 GitHub 上.

您可以通过以下步骤, 提交您对文档的改动:

  1. project X 文档仓库 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库.

  2. 使用任何您喜欢的工具, 从您克隆的仓库获得文档的克隆, 如:

git clone https://github.com/yours/XTLS.github.io
  1. 基于 main 分支创建新的分支, 如:
git checkout -b your-branch
  1. 在新分支上做修改, 完成后提交修改

  2. 推送创建的分支到您的仓库

git push -u origin your-branch
  1. 打开 github, 点击 'Pull request' 向 project X 文档仓库发出PR.

  2. 请在 PR 的标题和正文中,概述此次 PR 新增/修改的内容等;

  3. 等待回应, 如果 PR 被 merge, 您做的修改将直接呈现在 Project X 文档网站