ruby / ruby/rdoc

Consider renaming the title on `docs.ruby-lang.org` for better SEO

Open
#1,810 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

Search engines consider words closer together to be more relevant.
When I search for "Ruby Array" in Google I get the following results:

  1. "Class: Array (Ruby 3.0.1)" https://ruby-doc.org/core-3.0.1/Array.html
  2. "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:

  1. "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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.