贡献文档¶
我们欢迎对文档的贡献!如果您想贡献,请按照以下步骤操作。
设置文档¶
-
克隆仓库:
git clone github.com/Significant-Gravitas/AutoGPT.git
-
安装依赖项:
python -m pip install -r docs/requirements.txt
或者
python3 -m pip install -r docs/requirements.txt
-
使用 mkdocs 的实时服务器开始迭代:
mkdocs serve
-
打开浏览器并导航到
http://127.0.0.1:8000
。 -
当您保存更改时,服务器将自动重新加载文档。
添加新页面¶
- 在
docs/content
目录中创建一个新的 markdown 文件。 - 将新页面添加到
mkdocs.yml
文件的nav
部分。 - 将内容添加到新的 markdown 文件中。
- 运行
mkdocs serve
以查看您的更改。
检查链接¶
要检查文档中的断链,请运行 mkdocs build
并在控制台输出中查找警告。
提交拉取请求¶
当您准备好提交更改时,请创建一个拉取请求。我们将审查您的更改并在适当的情况下合并它们。