Weblateドキュメントへの貢献¶

ドキュメントページを選んで改善してください。ページの右上隅にある GitHub で編集ボタンをクリックすると簡単に編集できます。

ドキュメント作成ガイドライン¶

書き込みに際して従うべきガイドライン:

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

ドキュメントはローカルで編集およびビルドすることもできます。Python の依存関係は、pyproject.toml の docs 依存グループに定義されています。ビルドは ci/run-docs を使用して実行できます。

ヒント

ドキュメントをビルドするには、graphviz のインストールが必要です。

一部のドキュメントの各セクションでは、コードから生成されたテンプレートを使用しています。使用可能な管理コマンド:

このコマンドはすべて、ドキュメントのテンプレートとして使用される reStructuredText を出力します。ドキュメントに変更を適用する最も簡単な方法は、エディタのビジュアル差分機能を使用することです。