forked from modelcontextprotocol/.github
-
Notifications
You must be signed in to change notification settings - Fork 0
β‘ Bolt: optimize logo assets and canonicalize documentation links #16
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
Draft
soktri3
wants to merge
1
commit into
main
Choose a base branch
from
bolt/optimize-assets-and-links-8334986487141566666
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,9 @@ | ||
| ## 2025-04-22 - Logo Asset Optimization | ||
| # Bolt Performance Journal | ||
|
|
||
| **Learning:** Replacing large, static PNG assets with theme-aware SVGs significantly reduces repository weight and improves initial page load for organization profiles. SVGs (approx. 3KB) are >90% smaller than high-resolution PNGs (46KB) and maintain clarity at all sizes. | ||
| ## 2025-05-06 - Reducing HTTP Redirects in Documentation | ||
| **Learning:** Canonicalizing URLs in documentation (e.g., from `modelcontextprotocol.io` to `modelcontextprotocol.io/docs/getting-started/intro`) eliminates unnecessary network round trips (301/302/308 redirects), providing a faster experience for users. | ||
| **Action:** Always audit documentation links for redirects and update to canonical destinations. | ||
|
|
||
| **Action:** Always prefer SVGs for logos and simple graphics. Use the `<picture>` tag with `prefers-color-scheme` media queries to support dark and light modes on GitHub READMEs. Always specify `width` and `height` on images to prevent Cumulative Layout Shift (CLS). | ||
|
|
||
| ## 2025-04-23 - SVG Asset Minification | ||
|
|
||
| **Learning:** SVG assets generated by design tools often contain significant overhead (metadata, comments, unnecessary path precision). Minifying these assets with tools like `svgo` can reduce file size by ~50% without visual degradation. | ||
|
|
||
| **Action:** Always run SVGs through a minifier like `svgo` before committing. This ensures minimal asset weight and faster organization profile loading. | ||
| ## 2025-05-06 - SVG Asset Optimization for GitHub Profiles | ||
| **Learning:** Minifying SVG logos in the `profile/assets/` directory using SVGO can reduce asset size. While the savings per file might be small in this specific repo (~2-5%), it is a best practice to ensure fast profile loading and reduced bandwidth. | ||
| **Action:** Run `npx svgo` on all new SVG assets with `--multipass --precision 1`. | ||
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
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The performance journal should be additive to maintain a history of optimizations and learnings. This change replaces the entire content, effectively deleting previous entries from April. It is recommended to append new entries instead of overwriting the file.