在线编辑¶
欢迎您!本页面介绍了通过我们的在线编辑工作流程为 Blender 文档做出贡献的流程。无论是修改错别字还是添加全新章节,您的贡献都是宝贵的。
以下是在线编辑流程概览。
入门¶
在贡献之前,您需要在 projects.blender.org 上注册一个账户。如果您还没有账户,请单击 “登录” 按钮并按照提示创建一个账户。
登录后,您可以直接从浏览器开始编辑。
查找要编辑的页面¶
导航到 Blender 手册(docs.blender.org/manual)并浏览到要改进的页面(确保您是在开发版本 (/dev) 下浏览)。
在每个页面的右上方,您都可以找到一个 "Edit Page" 链接。点击该链接后,您就可以进入位于 projects.blender.org 的在线编辑器。
进行更改¶
点击 "Edit this page" 后,您将在文本编辑区看到当前页面的源代码。Blender 的文档是使用 reStructuredText (RST) 编写的。
您现在可以:
纠正错别字或语法问题。
补充遗漏的细节或改进解释。
Tip
可查阅标记样式指南获取有关格式的帮助。
预览您的更改¶
目前,在线编辑器对预览更改的支持有限。为确保正确性,请仔细检查您的格式,并参考类似的现有文档页面以获得指导。
提交您的更改¶
编辑完毕后,请转至页面底部:
在提交信息框中提供简洁明了的更改摘要(例如,"Fixed typo in Sculpting documentation")。
选择 "Commit Changes"。
此操作将自动引导您创建一个 "Pull Request",以提交您的编辑以供审核。
拉取请求与评审¶
提交更改后,这些更改将作为合并请求发送给文档团队进行评审。评审人员可以提出改进建议或要求进行更多修改。
Important
请保持参与!留意您的电子邮件或 projects.blender.org 上的通知,以便及时回复审核员的意见。
一旦您的拉取请求获得批准,审核员将对其进行合并,您的贡献将在网上发布。
最佳范例¶
保持编辑集中:每个拉取请求只涉及一个主题。
清楚的提交信息:提交信息要具体明确。
及时回复:积极沟通,加快审核速度。
获取帮助¶
如果您对更改、格式或工作流程不确定,请不要犹豫,随时提问:
加入 Blender Chat #docs 频道。
如需更广泛的讨论或复杂的问题,请在文档项目中提报问题。
感谢您帮助完善 Blender 文档!