为 Weblate 文档作贡献¶
欢迎您改进您选择的文档页面。通过单击页面右上角的 在 GitHub 上编辑 按钮轻松完成此操作。
文档准则¶
请在写作时遵守以下准则:
如果部分文档有效请不要将其删除。
请使用清晰易懂的语言。你正在写技术文档,而不是一首诗。并非所有文档读者都是母语人士,请深思熟虑。
如果你不确定不要害怕询问。如果你在编辑时必须询问某些功能。在你得到答案之前不要改变它的文档。这意味着你要么改变。要么询问。不要同时做这两件事。
在遵循文档的同时通过执行描述的操作来验证您的更改。
发送带有小块更改的PR以便更轻松更快速地查看和合并。
如果你想重写和改变一篇大文章的结构,请分两步进行:
重写
重写的内容经审校、润色并被合并后,在另一个 PR 中修改段落的结构。
本地构建文档¶
也可以在本地编辑并构建文档,Python 要求位于 pyproject.toml
中的 docs
依赖群。可以使用 ci/run-docs 执行构建。
提示
您还需要安装 graphviz 来构建文档。
翻译文档¶
你可以 翻译文档。
文档权限、检查、附加组件和自动建议¶
几个文档部分使用从代码生成的模板。下列管理命令可用:
所有这些命令输出用作文档模板的 reStructuredText。应用更改到文档的最简单方法是在编辑器中使用可视化差异比较。