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

Add favicon #152

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Add favicon #152

merged 1 commit into from
Oct 18, 2024

Conversation

thomasmarshall
Copy link
Contributor

@thomasmarshall thomasmarshall commented Oct 7, 2024

This PR adds a favicon which will be shown in the browser tab or when someone bookmarks the Ruby documentation site. Ideally we would add a link tag in the HTML files, but most browsers will default to /favicon.ico if the link isn't defined, so this is easier than configuring a custom RDoc template or post-processing the files.

I copied the favicon.ico file directly from ruby/www.ruby-lang.org.

Here's an example of the bookmark I keep in my browser bookmarks bar:

Before After

Perhaps this doesn't seem important, but the reason I have a bookmark is that it's currently quite difficult to reach official Ruby documentation via Google search. For example, try searching for "ruby array join" and you will see that the official Ruby docs are half way down the second page of results. As such, it would be great if the bookmark was easier to scan for visually.

@st0012
Copy link
Member

st0012 commented Oct 13, 2024

FWIW, I think RDoc should support customizing favicon as well. So I opened ruby/rdoc#1192

@hsbt hsbt merged commit 58364cd into ruby:master Oct 18, 2024
@st0012
Copy link
Member

st0012 commented Oct 21, 2024

Has this been deployed? Checking because https://docs.ruby-lang.org/favicon.ico still returns 404 for me.

@thomasmarshall
Copy link
Contributor Author

I saw your latest documentation style changes have been deployed @st0012 but the favicon is still 404. I don't know what the deployment process is—I assumed files in public would be publicly available at the root but perhaps that's not correct.

@hsbt
Copy link
Member

hsbt commented Oct 25, 2024

Don't rush that. I'll look that at next week.

@hsbt
Copy link
Member

hsbt commented Oct 30, 2024

https://docs.ruby-lang.org/favicon.ico is available now.

@st0012
Copy link
Member

st0012 commented Oct 30, 2024

@hsbt Thank you!

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

Successfully merging this pull request may close these issues.

3 participants