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

Updated icons, theme and improved icon device support #3030

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions app/views/application/_head.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@
<%# Links to pages on the same origin, but outside /docs site shouldn't use Turbo %>
<meta name="turbo-root" content="/docs">

<%= tag :link, rel: "shortcut icon", href: vite_asset_path("images/favicon.png"), type: "image/x-icon" %>
<%= tag :link, rel: "apple-touch-icon", href: vite_asset_path("images/appicon.png") %>
<%= tag :link, rel: "mask-icon", href: vite_asset_path("images/logo-pinned.svg"), color: "#14CC80" %>
<!-- Favicons and theming -->
<%= tag :link, rel: "icon", href: vite_asset_path("images/favicon.svg"), type: "image/svg+xml" %>
<%= tag :link, rel: "icon", href: vite_asset_path("images/favicon.png"), type: "image/png" %>
<%= tag :link, rel: "apple-touch-icon", href: "/apple-touch-icon.png" %>
<%= tag :meta, property: "theme-color", media:"(prefers-color-scheme: light)", content:"#FFFFFF" %>
<%= tag :meta, property: "theme-color", media:"(prefers-color-scheme: dark)", content:"#020617" %>
<%= tag :link, rel: "manifest", href: "/manifest.json", crossOrigin: "use-credentials" %>

<!-- Twitter Cards Metadata -->
<%= tag :meta, property: "twitter:card", content: content_for(:page_twitter_card) || "summary_large_image" %>
Expand Down
Binary file removed images/docs/appicon.png
Binary file not shown.
Binary file modified images/docs/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions images/docs/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion images/docs/logo-pinned.svg

This file was deleted.

Empty file.
Binary file modified public/apple-touch-icon.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CleanShot 2025-01-15 at 14 28 22@2x

GitHub’s diff view is sad about this file for some reason (maybe an issue on my end?), but viewing the file directly seems ok.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed public/favicon.ico
Empty file.
Binary file added public/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/icon-192.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone added docs and bk/bk to their dock, would the dock icons would be identical?

CleanShot 2025-01-15 at 14 33 13@2x

Maybe a macOS dock icon is an opportunity for a more expressive, Gavin Nelson style app icon which includes some sort of docs illo affordance (inb4 beautifully 3d rendered curling document page illo)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I reckon this is a solid call - as you suggested each site/app having it's own unique flavour would be awesome

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/icon-512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions public/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "Buildkite Documentation",
"short_name": "Buildkite Docs",
"start_url": "/docs",
"display": "standalone",
"description": "Automate your team’s software development processes, from testing through to delivery, no matter the language, environment or toolchain.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder if there’s any value in distinct manifest descriptions between site/docs/product dashboard?

(Not a high priority, didn’t even have the manifest before.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly got no idea haha, I just based it on our url setups but nfi what it actually does and what it affects 😅

"icons": [
{
"src": "/icon-192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "/icon-512.png",
"type": "image/png",
"sizes": "512x512"
}
]
}
Loading