Skip to content

Commit ce18628

Browse files
authored
Merge pull request #3036 from znz/docs/manual-editing-guide
Document that editing now happens in manual/ (Markdown)
2 parents 49edbf8 + 8fa0cdb commit ce18628

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,36 @@ Ruby の安定版リリースをベースとした、
1414
* オンライン HTML、静的 HTML、HTML Help、EPUB3、
1515
ReFe データベースのすべてが用意されている
1616

17+
## ドキュメントの編集
18+
19+
ドキュメント本体は `manual/` 配下の Markdown ファイルです
20+
(2026年7月に RD ベースの独自記法 RRD から移行しました)。
21+
22+
* `manual/api/` — 組み込みクラス・標準添付ライブラリ(例: `manual/api/_builtin/Array.md`
23+
* `manual/doc/` — 言語仕様などの文書
24+
* `manual/capi/` — C API
25+
26+
https://docs.ruby-lang.org/ja/ の各ページ下部の編集リンクから、
27+
該当する `manual/` のファイルに直接飛べます。
28+
29+
`refm/` ツリーは凍結されています。編集しても公開サイトには反映されないため、
30+
編集しないでください(旧バージョン向け情報の回収が終わり次第、削除予定です)。
31+
32+
記法は GitHub Flavored Markdown ベースです。メソッドシグネチャ
33+
`### def each {|item| ... } -> self`)やクロスリファレンス(`[m:Array#each]`
34+
などの独自拡張の仕様は、bitclust の
35+
[MARKUP_SPEC.md](https://github.com/rurema/bitclust/blob/master/doc/markdown-samples/MARKUP_SPEC.md)
36+
を参照してください。バージョン別の記述に使う `#@since` / `#@until` などの
37+
プリプロセッサ指令は従来どおり使えます。
38+
39+
ローカルでのビルド・確認:
40+
41+
```console
42+
$ bundle install
43+
$ bundle exec rake generate:3.4 # BitClust データベース生成
44+
$ bundle exec rake statichtml:3.4 # 静的 HTML 生成
45+
```
46+
1747
## 各バージョンの対応方針
1848

1949
以下の方針で対応します。

README

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
Rubyリファレンスマニュアル刷新計画 README
22
=========================================
33

4-
See: https://github.com/rurema/doctree/wiki
4+
ドキュメント本体は manual/ 配下の Markdown ファイルです
5+
(2026年7月に RD ベースの独自記法 RRD から移行しました)。
6+
編集のしかたは CONTRIBUTING.md を参照してください。
57

8+
See: https://github.com/rurema/doctree/wiki

0 commit comments

Comments
 (0)