本サイトはGithubPages上で運用されています。 GithubActionsによって自動でサイトに反映されますので、ビルドしたものをあげる必要はありません。
mdbookを使用しているので、基本的にはMarkdownで記述することとなっております。 mdbookでの記法については こちら を参考にしてください。
rustdocsjpは編集者の独自の理解と解釈によって書かれる解説サイトです。「こちらのほうがわかりやすい」といった表現がありましたら、そちらのほうを記載してもらって構いません。ただし、必ず公式のドキュメントを参考にしてください。
また、rustdocsjpには様々な書き方のルールがあります。 これは統一したフォーマットにすることにより読みやすくすることが目的です。 コントリビュートが初めての方は、 vecモジュール を参考にしてみてください。多くのルールはここにHTMLコメントとして記載されてあります。 vecモジュールにないことは、まずIssueを立てて相談しましょう。 ルールが決定したら管理者がvecモジュールにコメントを追加します。
現時点では、編集中であることを周りに示す目的で、編集中のページに関するドラフトプルリクエストを立てることとなっています。 これは、余計なコンフリクトを避け、互いの無駄な作業を避けるためです。
「はじめに」などの冒頭ページ以外、すなわち皆さんが書くリファレンスページでは、必ず「である」調で書いてください。 また、モジュールを一つ追加するごとに modlist.md を更新してくださるようお願いします。
また、PRする際にはPRテンプレートにあるチェックリストを参照してください
誤字脱字の修正も立派な貢献です。また、本サイトはわかりやすさを重要視しております。もし「こちらのほうがいいのでは」といった案がありましたら、ぜひIssueに書き込んでください。