Consider renaming the title on `docs.ruby-lang.org` for better SEO
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- ruby
- Domain
- documentation
Research direction
Start by locating the RDoc HTML title generation used for pages such as the Array documentation on docs.ruby-lang.org, then compare its output with the title examples in the issue. Done means the generated title follows the proposed Ruby-and-class wording and the relevant documentation output or tests confirm it.
Written by the indexing model from the issue text.
Description
Search engines consider words closer together to be more relevant.
When I search for "Ruby Array" in Google I get the following results:
- "Class: Array (Ruby 3.0.1)" https://ruby-doc.org/core-3.0.1/Array.html
- "class Array - RDoc Documentation" https://docs.ruby-lang.org/en/2.5.0/Array.html
As ruby-doc.org has "Array" next to "Ruby" ruby-doc.org scores better than docs.ruby-lang.org.
When I search for the exact title "array documentation for Ruby 3.4" docs.ruby-lang.org gets the top spot:
- "class Array - Documentation for Ruby 3.4" https://docs.ruby-lang.org/en/3.4/Array.html
I suspect renaming the title to "class Array (Ruby 3.4 documentation)" will help SEO for docs.ruby-lang.org.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
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.
More from ruby/rdoc
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
simp/pupmod-simp-simp#395 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
simp/pupmod-simp-rsyslog#219 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
simp/pupmod-simp-pupmod#256 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
simp/pupmod-simp-sudo#150 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100