对文档的贡献

感谢您为Donkeycar项目做出贡献。文档对于我们用户的成功非常重要，因此我们非常感谢您的贡献。准确性和完整性至关重要。许多用户是初学者，因此请在撰写贡献时牢记这一点；不要假设“他们应该已经知道这个”。

我们使用mkdocs包来创建https://donkeycar.cn 网站的HTML。存储库中的文件采用Markdown格式；mkdocs将其“编译”为HTML，以便在浏览器中显示。您可以在donkeydocs存储库的自己的Fork中进行更改，并打开一个Pull Request，以便由维护者之一将其合并到主要的donkeydocs存储库中。一旦PR被合并，更改将自动编译并推送到https://donkeycar.cn网站。

  1. 在您的GitHub帐户中Fork donkeydocs存储库。
  2. 将您的Fork克隆到计算机上，以便您有一个可以进行更改的本地副本。
  3. 在克隆的Fork中创建一个新的分支；该分支将用于进行更改/添加。如果这与主存储库中的问题有关，则将分支名称以问题编号开头。
  4. 进行更改/添加，并在您的Fork中进行检查。我们使用一个名为mkdocs的软件包将您编辑/创建的Markdown文件编译为HTML。有关它使用的Markdown格式的详细信息，请参阅mkdocs文档。如果您安装了mkdocs，可以使用它生成实时预览，以便在保存更改时查看更改。
  5. 打开控制台（在Windows上是Git Bash控制台）并cd到克隆的donkeydocs项目文件夹的根目录。
  6. 创建一个Python虚拟环境并激活它。
  7. 在激活的虚拟环境中安装mkdocs软件包。
  8. 运行mkdocs服务器。这将为您提供一个URL，您可以在浏览器中打开该URL以查看渲染后的文档。 python3 -m venv env source env/bin/activate pip3 install mkdocs mkdocs serve

  9. 在后续的编辑会话中，只需重新激活虚拟环境并启动mkdocs服务器（无需重新创建环境，只需重新激活它）。

  10. 完成在分支中进行更改/添加后，提交更改并将其推送到您的Forked存储库。如果发现需要进行更多更改，只需重复这个过程；进行更改、提交更改、推送更改。

  11. 一旦您确定更新是正确的，并且它们已推送到您的Forked存储库，请打开一个Pull Request。因为您创建了主donkeydocs存储库的Fork，所以您可以在主存储库中反映此Pull Request。Github有一个很好的功能；在您推送到Forked存储库后；如果您转到github.com上的存储库，您将看到一个绿色的“Compare & Pull Request”按钮；您可以点击它来创建您的Pull Request。
  12. 这将在主donkeydocs存储库中打开一个Pull Request。我会在Discord的维护者频道中通知您已经打开了PR，这样有人就会对其进行审查。在PR过程中，您可以预期进行几轮评论。如果收到更改请求，则可以根据这些评论进行更改并推送它们；新的更改将在Pull Request中反映出来。

这个过程在这里有更详细的文档 https://docs.github.com/en/get-started/quickstart/contributing-to-projects