Skip to content

Commit aef57c3

Browse files
authored
Merge pull request #3040 from znz/docs/triage-content
docs: rewrite and refresh the imported wiki pages for the Markdown era
2 parents 64163e9 + 900e7cc commit aef57c3

22 files changed

Lines changed: 748 additions & 1269 deletions

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,24 @@ $ bundle exec rake generate:3.4 # BitClust データベース生成
4444
$ bundle exec rake statichtml:3.4 # 静的 HTML 生成
4545
```
4646

47+
手を動かしながらの詳しい手順は [docs/Tutorial.md](docs/Tutorial.md) を、
48+
プロジェクト文書の一覧は [docs/](docs/) を参照してください。
49+
50+
## いろいろな貢献のかたち
51+
52+
ドキュメントの編集以外にも、次のような貢献を歓迎しています。
53+
資格は特に必要ありません。日本語が扱えると助かります。
54+
Ruby でプログラミングができるとサンプルの検証などもできて便利ですが、必須ではありません。
55+
56+
* ドキュメントの誤りの指摘(バージョン間違いなど) —
57+
[Issue](https://github.com/rurema/doctree/issues/new) を登録してください。
58+
最新版で修正済みかどうかを先に確認してもらえると助かります。
59+
修正内容がわかっている場合は Pull Request にしていただけると適用が楽になります
60+
* ドキュメントをよりよくするための提案(説明文の追加など)
61+
* サンプルコードの提供
62+
* 既に上がっている Issue へのコメント
63+
* ブログや勉強会などで「るりま」を紹介する
64+
4765
## 各バージョンの対応方針
4866

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

docs/CapiReferenceManual.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
1+
# C API リファレンス
2+
13
<dl>
24
<dt>名前</dt>
35
<dd>C API リファレンス</dd>
46
<dt>URL</dt>
57
<dd><a href="https://docs.ruby-lang.org/ja/latest/function/index.html">https://docs.ruby-lang.org/ja/latest/function/index.html</a></dd>
6-
<dt>代替 URL</dt>
7-
<dd><a href="http://doc.okkez.net/193/view/function/">http://doc.okkez.net/193/view/function/</a></dd>
8+
<dt>ソース</dt>
9+
<dd><code>manual/capi/*.md</code>(1ファイル = Ruby の1ソースファイル。例: <code>array.c.md</code>)</dd>
810
<dt>概要</dt>
911
<dd>
1012
C API リファレンスは、拡張ライブラリや組み込み Ruby で用いる
1113
C 言語の API (関数やマクロ) を記述したリファレンスです。
1214
</dd>
1315
</dl>
1416

17+
書式はクラスリファレンスとほぼ共通ですが、シグネチャの H3 に
18+
`def` などのキーワードを付けません(C のシグネチャは型から始まるため)。
19+
20+
```markdown
21+
### VALUE rb_ary_new()
22+
23+
空の Ruby の配列を作成し返します。
24+
```
25+
26+
詳細は [MARKUP_SPEC.md](https://github.com/rurema/bitclust/blob/master/doc/markdown-samples/MARKUP_SPEC.md) の「C API リファレンス」の節を参照してください。
27+
1528
## 関連
1629

17-
* [[ProjectTimeLine]]
18-
* [[ToDo]]
19-
* [[BitClust]]
30+
* [ProjectTimeLine](archive/ProjectTimeLine.md)(歴史的経緯)
31+
* [BitClust の使い方](https://github.com/rurema/bitclust/blob/master/doc/usage.md)

0 commit comments

Comments
 (0)