贡献文档¶
我们欢迎您为我们的文档做出贡献!如果您想参与贡献,请按照以下步骤操作。
设置文档环境¶
-
克隆仓库:
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
并在控制台输出中查找警告信息。
提交拉取请求¶
当您准备好提交更改时,请创建一个拉取请求。我们将审核您的更改,并在合适的情况下将其合并。