Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Most documentation pages have empty <title> tags #205

Open
davidjb opened this issue May 26, 2024 · 3 comments
Open

Most documentation pages have empty <title> tags #205

davidjb opened this issue May 26, 2024 · 3 comments

Comments

@davidjb
Copy link

davidjb commented May 26, 2024

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.

@JonRowe
Copy link
Member

JonRowe commented May 27, 2024

I assume you're talking about the gherkin documentation seeing as I think all of the original pages have titles, this is certainly an area that can use improvement as it was hastily generated after relish went away, we're using a tool to generate the md files which fufilled the task of "not having to write from scratch" gherkin2markdown so manually adding frontmatter isn't really an option as it would be a nightmare to maintain, using the first h1 is an interesting idea but someone would probably have to write a plugin for middleman to make that happen.

@davidjb
Copy link
Author

davidjb commented May 27, 2024

Apologies, I realise I didn’t include an example URL:
https://rspec.info/features/3-13/rspec-core/helper-methods/let/ and
https://rspec.info/features/6-1/rspec-rails/matchers/
were two pages I noticed it happening on recently: the search engine result titles didn’t align with the URLs & content.

@JonRowe
Copy link
Member

JonRowe commented May 27, 2024

Those are indeed autogenerated pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants