「るりま大刷新計画2022最終報告」
メンター報告書

# プロジェクト概要

本プロジェクトは、日本語のRuby用リファレンスマニュアル（るりま）を記述す
るためのシステムであるbitclustが、独自の記法（RDベース）を用いており、
Githubなどでよく利用されているMarkdown形式が利用できないという問題を解決
するために、Markdown形式での記述も許すようbitclustを拡張することを目標し
ている。

# 計画の達成状況

まずは、そもそも実現可能か、という調査から始まり、bitclustとMarkdownまわ
りの実装の調査、るりまを利用する外部システムの調査、およびMarkdownで現在
のリファレンスマニュアルに掲載されている内容が表現可能か、という調査が行
われ、それがある程度実現可能であることを確認した。

そのうえで、Markdownによるドキュメントの表現方法を定め(*1)、これを実現す
るためにbitclustシステムについて改修した。

*1: https://gist.github.com/znz/82f32930408c60bbe14ca9c3d580a972

まだ、多くのドキュメント記述者にMarkdownへの移行を促すほど完成度とはなっ
ておらず、メンターが担当可能なドキュメントを試しに書く、という目標は達成
できていないが、細かい積み残した課題を改善することで、今後実際に利用され
るシステムとなることが大きく期待できる。また、RBSによる型定義に対応する
など、さらなる拡張も期待できる。

# メンターとして果たした役割

ほぼ毎週のオンラインミーティングで進捗を確認し、気になる仕様（主にドキュ
メントのMarkdownによる記述性やシステムの全体構成）について議論した。その
際、Grantプロジェクトのマイルストーンについて都度確認した。

# まとめ

本プロジェクトでは、るりまの記述を独自のRDベースの言語ではなく、モダンな
Markdownで記述可能にするシステムについて、多くのコンポーネントを実現した。
Markdownでの記述が可能になることで、ドキュメントに対する貢献がやりやすく
なり、より一層のドキュメントの品質向上が期待できる。実際に利用できるまで、
まだ少しかかると思うが、ぜひ実現していただきたい。