Weblateドキュメントへの貢献¶
ドキュメント ページを選んで改善してください。ページの右上隅にある GitHub で編集 ボタンをクリックすると簡単に編集できます。
ドキュメント作成ガイドライン¶
書き込みに際して従うべきガイドライン:
妥当な翻訳のドキュメントの部分は削除しないでください。
明確でわかりやすい語彙を使用してください。技術文書を記述しているのであって、詩を書いているのではありません。ドキュメントを読む人がすべてネイティブスピーカーなわけではないことに注意してください。
確信が持てない場合は、遠慮なく質問してください。編集中に、特定の機能について質問をする必要がある場合は、回答を得られる前にそのドキュメントを変更しないでください。つまり、変更するか質問するか、どちらかにしてください。両方を同時に実行しないでください。
ドキュメントに従って説明どおりの操作を行い、変更を確認してください。
査読とマージを簡単かつ迅速に行えるように、変更を小さな単位で書き込んで公開ください。
大きな文章の構成を書き換えて変更する場合の手順:
書き換え
書き換えが査読され、洗練され、マージされたら、他の公開する段落構成を変更します。
ローカルでドキュメントをビルドする¶
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.