Improve SEO and page titles

lsegal · lsegal · commit e1f999e12623 · 2025-05-07T11:25:55.000-07:00
diff --git a/app/controllers/concerns/alpha_indexable.rb b/app/controllers/concerns/alpha_indexable.rb
@@ -8,6 +8,7 @@ module AlphaIndexable
   def set_alpha_index
     @has_alpha_index = true
     @letter = params[:letter] || default_alpha_index
+    @page_title = "#{@title} Index: #{@letter.upcase}" if @letter.present?
     set_alpha_index_collection
   end
 
diff --git a/app/controllers/concerns/searchable.rb b/app/controllers/concerns/searchable.rb
@@ -7,6 +7,7 @@ module Searchable
 
   def load_search_query
     @search = params[:q]
+    @page_description = "#{@title} Search Results for '#{h @search}'"
     @exact_match = @collection.dup.where("lower(name) = ?", @search.downcase).first
     @collection = @collection.where("lower(name) LIKE ? AND lower(name) != ?", "%#{@search.downcase}%", @search.downcase)
   end
diff --git a/app/controllers/featured_controller.rb b/app/controllers/featured_controller.rb
@@ -4,6 +4,7 @@ class FeaturedController < ApplicationController
 
   prepend_before_action do
     @title = "Featured Libraries"
+    @page_title = @title
     @collection = featured_libraries
   end
 
diff --git a/app/controllers/stdlib_controller.rb b/app/controllers/stdlib_controller.rb
@@ -3,6 +3,7 @@ class StdlibController < ApplicationController
 
   prepend_before_action do
     @title = "Ruby Standard Library"
+    @page_title = @title
     @collection = Library.stdlib.all
   end
 
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
@@ -30,6 +30,18 @@ def settings
     Rubydoc.config
   end
 
+  def page_title
+    "#{settings.name}: #{title_content}"
+  end
+
+  def title_content
+    @page_title || content_for(:title) || page_description
+  end
+
+  def page_description
+    @page_description || content_for(:description) || settings.description
+  end
+
   def link_to_library(library, version = nil)
     prefix = case library.source
     when :featured
diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= content_for(:title) || Rubydoc.config.name %></title>
+    <%= render "shared/meta" %>
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
     <%= yield :head %>
diff --git a/app/views/shared/_meta.html.erb b/app/views/shared/_meta.html.erb
@@ -0,0 +1,14 @@
+<title><%= h page_title %></title>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="description" content="<%= h page_description %>" />
+<% if @search %>
+  <meta name="robots" content="noindex, nofollow">
+<% else %>
+  <meta name="robots" content="index, follow">
+<% end %>
+<link rel="canonical" href="<%= request.original_url %>">
+<meta property="og:title" content="<%= h page_title %>">
+<meta property="og:description" content="<%= h page_description %>">
+<meta property="og:image" content="<%= URI(request.original_url).tap { it.path = "/favicon.ico" }.to_s %>">
+<meta property="og:url" content="<%= request.original_url %>">
+<meta property="og:type" content="website">
diff --git a/app/views/shared/library_list.html.erb b/app/views/shared/library_list.html.erb
@@ -5,7 +5,7 @@
   </div>
 <% end %>
 <h2>
-  <%= @title %> <%= h @search ? "Search Results for '#{@search}'" : 'Listing' %>
+  <%= h @search ? @page_description : "#{@title} Listing" %>
   <% if @search %>
     <span class="small">(<%= link_to "Back to Listing", controller: controller_name %>)</span>
   <% end %>
diff --git a/config/initializers/rubydoc.rb b/config/initializers/rubydoc.rb
@@ -5,6 +5,7 @@ def self.config; @config; end
   def self.config=(config)
     @config = JSON.parse({
       name: "RubyDoc.info",
+      description: "Documenting RubyGems, Stdlib, and GitHub Projects",
       integrations: {
         rubygems: Rails.application.credentials.rubydoc&.rubygems_api_key,
         cloudflare_token: Rails.application.credentials.rubydoc&.cloudflare_token,
diff --git a/config/rubydoc.yml.sample b/config/rubydoc.yml.sample
@@ -3,6 +3,9 @@ default: &default
   # Display title. Defaults to RubyDoc.info
   # name: RubyDoc.info
 
+  # Default page description
+  # description: Documenting RubyGems, Stdlib, and GitHub Projects
+
   gem_hosting:
     # If you want to enable or disable gem hosting, set the following to true or false
     # enabled: true
