rspec / rspec/rspec.github.io

Most documentation pages have empty `<title>` tags

Open
#205 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
15
Forks
41
Avg merge
4m
Merged PRs (30d)
1

Description

I noticed that in web search results, results from rspec.info have empty titles (or show inconsistent text), making it unclear what's on each page. The cause is that the <title> tags are empty for most pages, except those with frontmatter (e.g. #32).

If the first H1 could be used as the default for the title in the absence of frontmatter, that should solve the issue without having to add titles to every page manually.

Either way, ensuring pages have titles is useful for both accessibility and search engines and would be a real help to be added to the RSpec docs.

Contributor guide

No contributing guide indexed for this repository

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

No file or test is named. Start by locating the documentation page-generation entry point for rspec.info and inspect how frontmatter, the first H1, and the HTML title are handled. Done means pages without frontmatter receive a meaningful title and search results no longer show empty or inconsistent titles.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation, search
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.