Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,6 @@

<!-- 例: fixes #123 -->

## チェックリスト

- [] 作業中 (ドラフトPR)

---

- [] サポートしているバージョンを明記した
- [] modlist.mdを更新した(モジュール追加時)
- [] [CONTRIBUTING.md](CONTRIBUTING.md) のルールに従っている
- [] ライセンス/著作権に問題がない

## レビューで見てほしい点

<!-- 特に見てほしい箇所や懸念点を記載 -->
38 changes: 0 additions & 38 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,5 @@
# Contributing Guide

## 記事編集

### 編集するにあたって

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

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

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

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

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

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

### 編集方法

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

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

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

## はじめに
```

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

## デザイン編集

デザイン編集をする前にnpm、nodejs、bunをインストールしてください。
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# rustrefjp - Rust言語非公式日本語ドキュメント

rustrefjp は、Rust 標準ライブラリおよび関連仕様について、公式ドキュメントの単純な翻訳ではなく、各ライターの理解と解釈に基づいて日本語で解説する非公式プロジェクトです。
rustrefjp は、Rust 標準ライブラリおよび関連仕様について、AIによってリファレンスを翻訳していくプロジェクトです。
AIによって作られた翻訳は、レビュアーが細心の注意を以て確認しています。

## 貢献

Expand Down
18 changes: 18 additions & 0 deletions content/docs/(Introduction)/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: rustrefjp
description: Rust標準ライブラリの日本語リファレンスです。
---

rustrefjpは、公式リファレンスをAIによって翻訳するプロジェクトです。
AIによって翻訳されたページはレビュアーが細心の注意を以てチェックしています。
正確性には最大限配慮していますが、内容の完全性・公式性を保証するものではありません。
原典については必ず公式ドキュメントを参照してください。

## 方針

本サイトは常にRust言語の最新リファレンスを掲載し続けることを目標にしています。
また、Rust言語の入門として使えるよう、わかりやすさも重視しております。

# ライセンス

Rustの慣習に従い、明記されてない限りはMIT OR Apache License 2.0で管理されています。
97 changes: 0 additions & 97 deletions content/docs/1.95.0/index.mdx

This file was deleted.

5 changes: 0 additions & 5 deletions content/docs/1.95.0/meta.json

This file was deleted.

Loading