Conversation
st0012
approved these changes
Oct 13, 2024
Member
|
FWIW, I think RDoc should support customizing favicon as well. So I opened ruby/rdoc#1192 |
Member
|
Has this been deployed? Checking because https://docs.ruby-lang.org/favicon.ico still returns 404 for me. |
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 |
Member
|
Don't rush that. I'll look that at next week. |
Member
|
https://docs.ruby-lang.org/favicon.ico is available now. |
Member
|
@hsbt Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
linktag in the HTML files, but most browsers will default to/favicon.icoif thelinkisn't defined, so this is easier than configuring a custom RDoc template or post-processing the files.I copied the
favicon.icofile directly from ruby/www.ruby-lang.org.Here's an example of the bookmark I keep in my browser bookmarks bar:
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.