contributing.md

Contributing Guide

記事編集

編集するにあたって

rustdocsjpは編集者の独自の理解と解釈によって書かれる解説サイトです。「こちらのほうがわかりやすい」といった表現がありましたら、そちらのほうを記載してもらって構いません。ただし、必ず公式のドキュメントを参考にしてください。

また、rustdocsjpには様々な書き方のルールがあります。 これは統一したフォーマットにすることにより読みやすくすることが目的です。 コントリビュートが初めての方は、 vecモジュール を参考にしてみてください。多くのルールはここにHTMLコメントとして記載されてあります。 vecモジュールにないことは、まずIssueを立てて相談しましょう。 ルールが決定したら管理者がvecモジュールにコメントを追加します。

現時点では、編集中であることを周りに示す目的で、編集中のページに関するドラフトプルリクエストを立てることとなっています。 これは、余計なコンフリクトを避け、互いの無駄な作業を避けるためです。

「はじめに」などの冒頭ページ以外、すなわち皆さんが書くリファレンスページでは、必ず「である」調で書いてください。 また、モジュールを一つ追加するごとにmodlist.mdxを更新してくださるようお願いします。

また、PRする際にはPRテンプレートにあるチェックリストを参照してください。

PR自体は完成品である必要性はありません。ページの一部でも構いません。気づいた人が補完してくれるでしょう。 ですので、気軽にどんどんPRしてください。

編集方法

記事編集自体にnpm、node.js、bunのインストールは不要です。 content/docsに全ての記事がmdxで入っています。 ファイル構造は実際のドキュメントの構造とリンクしています。

mdxを書く際は冒頭に以下のように書き始めてください。titleとdescriptionの記入は必須です。

---
title: rustrefjp
description: Rust標準ライブラリを日本語に翻訳する非公式プロジェクトです。
---

## はじめに

本ドキュメントはフレームワークにFumadocsを採用しています。 基本的にはMarkDownと書き方は同じですがFumadocsでは一部GFM(GitHub Flavored Markdown)本来の記法と異なる記法での記述が求められます。 詳しくはFumadocs Docsをご覧ください。

デザイン編集

デザイン編集をする前にnpm、nodejs、bunをインストールしてください。

本ウェブサイトにはFumadocsを使用しています。Fumadocsに対して分からない部分がある際は一度Fumadocs Docsをご覧ください。 また本ウェブサイトはReact、Tailwindcssを使用しています。HTMLやCSSとは記法が異なりますので分からない場合は一度ご自身で調べていただけると幸いです。

最後に

誤字脱字の修正も立派な貢献です。また、本サイトはわかりやすさを重要視しております。もし「こちらのほうがいいのでは」といった案がありましたら、ぜひIssueに書き込んでください。