ruby / ruby/docs.ruby-lang.org

Generate all Ruby versions' documentation with the latest (released) RDoc

オープン
#153 コメント 0 件 リアクション 4 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Ruby
スター
53
フォーク
27
平均マージ
1時間 39分
マージ済み PR(30日)
2

説明

I recently made quite a few theme improvements to RDoc, along with community contributed changes like SEO tags...etc., which are all applied to the master documentation (https://docs.ruby-lang.org/en/master/index.html).
But since most of users will still be using Ruby 3.3 and prior versions for years to come, I think it'd be better if we can apply the same changes to their documentation too. I'd appreciate some pointers or even collaborations to make that happen. Thank you 🙂

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

docs.ruby-lang.org/en/master/index.html の master ドキュメントと、Ruby 3.3 およびそれ以前のバージョンのバージョン付きドキュメントを比較して、生成方法の違いを特定します。次に、このリポジトリのドキュメント生成のエントリーポイントを調べ、サポート対象の Ruby バージョン全体に最新リリースの RDoc を適用する方法を判断します。バージョン付きサイトに要求された theme と SEO の改善が含まれれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ruby
領域
build-system, documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。