跳到内容

贡献文档

我们欢迎您为我们的文档做出贡献!如果您想贡献,请按照以下步骤操作。

设置文档

  1. 克隆仓库

    git clone github.com/Significant-Gravitas/AutoGPT.git
    
  2. 安装依赖

    python -m pip install -r docs/requirements.txt
    

    python3 -m pip install -r docs/requirements.txt
    
  3. 使用 mkdocs 的实时服务器开始迭代

    mkdocs serve
    
  4. 打开浏览器并导航到 http://127.0.0.1:8000

  5. 当您保存更改时,服务器会自动重新加载文档。

添加新页面

  1. docs/content 目录中创建一个新的 markdown 文件。
  2. 将新页面添加到 mkdocs.yml 文件中的 nav 部分。
  3. 将内容添加到新的 markdown 文件。
  4. 运行 mkdocs serve 查看您的更改。

要检查文档中的失效链接,请运行 mkdocs build 并查看控制台输出中的警告。

提交拉取请求 (Pull Request)

当您准备好提交更改时,请创建一个拉取请求 (pull request)。我们将审查您的更改,并在适当的情况下将其合并。