ruby / ruby/docs.ruby-lang.org
Generate all Ruby versions' documentation with the latest (released) RDoc
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 53
- Forks
- 27
- Avg merge
- 1h 39m
- Merged PRs (30d)
- 2
Description
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 🙂
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the master documentation at docs.ruby-lang.org/en/master/index.html with the versioned Ruby 3.3 and earlier documentation to identify the generation differences. Then inspect this repository's documentation-generation entry points and determine how the latest released RDoc can be applied across supported Ruby versions; done means the versioned sites contain the requested theme and SEO improvements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100