为 Weblate 文档作贡献¶
欢迎您改进您选择的文档页面。通过单击页面右上角的 在 GitHub 上编辑 按钮轻松完成此操作。
文档准则¶
请在写作时遵守以下准则：
如果部分文档有效请不要将其删除。
请使用清晰易懂的语言。你正在写技术文档，而不是一首诗。并非所有文档读者都是母语人士，请深思熟虑。
如果你不确定不要害怕询问。如果你在编辑时必须询问某些功能。在你得到答案之前不要改变它的文档。这意味着你要么改变。要么询问。不要同时做这两件事。
在遵循文档的同时通过执行描述的操作来验证您的更改。
发送带有小块更改的PR以便更轻松更快速地查看和合并。
如果你想重写和改变一篇大文章的结构，请分两步进行：
重写
重写的内容经审核、润色并被合并后，在另一个 PR 中修改段落的结构。
本地构建文档¶
Documentation can be also edited and built locally, the Python requirements are
in the docs dependency group in pyproject.toml. If you already use
the full development environment, uv sync --all-extras --dev is enough. For
documentation work only, uv sync --group docs is sufficient.
The recommended local workflow is:
make -C docs update-docs
./ci/run-docs
The ci/run-docs wrapper builds the documentation with warnings treated as errors.
提示
您还需要安装 graphviz 来构建文档。
翻译文档¶
你可以 翻译文档。
Updating generated documentation snippets¶
Several documentation sections use templates generated from the code. The preferred way to refresh them is:
make -C docs update-docs
This target regenerates the snippets currently used by the documentation, including:
add-on events, built-in add-ons, and common add-on parameters
machine translation services
file format parameters and file format feature tables
permissions and built-in roles
checks and check flags
Keep manually maintained text in the parent documentation page rather than adding it to autogenerated snippets. For example, 附加组件 includes three generated files for events, built-in add-ons, and common add-on parameters, while obsolete add-ons are maintained directly in the page.
If you need to regenerate only one part, the individual management commands are
documented in 管理命令, and the exact commands used by
update-docs are listed in docs/Makefile.