[ruby-core:122185] [Ruby Misc#21350] Bundled gems lack online documentation

Issue #21350 has been updated by st0012 (Stan Lo).


Yeah it's a problem that we should resolve it before Ruby 3.5's release.

However, if the gem's source is no longer synced to `ruby/ruby`, then with the current RDoc features it's very hard to generate its documentation as part of Ruby's. Also, if the intention is for those gems to be declared as dependencies, regardless if they can be directly required or not, I think they should:

1. have their own documentation 
2. AND those should be linked from Ruby's doc

For 2, we can use the [standard libraries page](https://docs.ruby-lang.org/en/master/standard_library_md.html#label-Bundled+gems) to host those doc. It currently only links to the gems' GH repos, but we can add links to their docs when they have one.

For 1, I have configured documentation generation workflows for [IRB](https://github.com/ruby/irb/blob/master/.github/workflows/gh-pages.yml), [Reline](https://github.com/ruby/reline/blob/master/.github/workflows/gh-pages.yml), and [RDoc](https://github.com/ruby/rdoc/blob/master/.github/workflows/gh-pages.yml). As you can see, they are pretty similar. So if we standardize the RDoc generation configs for other bundled gems, we can definitely make a shared GH actions to publish their docs in the same way. 

But in addition to code changes, we'll also need to configure each repo to use GH pages. Should be a one time thing but it needs to be done by someone having admin permission to those repos (which I don't have).

----------------------------------------
Misc #21350: Bundled gems lack online documentation
https://bugs.ruby-lang.org/issues/21350#change-113331

* Author: osyoyu (Daisuke Aritomo)
* Status: Open
----------------------------------------
Libraries which have been converted into bundled gems seem to have no online documentation.

For example, `csv` had its documentation inside docs.ruby-lang.org up to Ruby 3.3:
https://docs.ruby-lang.org/en/3.3/CSV.html

but after it has turned into a bundled gem, there is no online documentation (try searching in https://docs.ruby-lang.org/en/3.4/).

This is the case for all bundled gems, including major modules such as `Base64` (missing since 3.4 docs) and `Logger` (missing since master docs).
Given that these libraries are still `require`able without any special installation, it would be nice to have their documentation on docs.ruby-lang.org (or somewhere online reachable from Google).



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- [e-mail]
 To unsubscribe send an email to [e-mail]
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/