Docs: Add note about Favicon Caching in Vercel #65755
Open
+1
−0
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.
What?
This PR adds a note to inform users of Vercel's build cache, which makes it difficult to replace favicon files once deployed.
Why?
There are many posts about issues replacing favicons on Stack Overflow, Reddit, Github etc. Many solutions involve renaming favicon.ico in the app folder to icon.ico, which works well but it's not clear why from what is said in the docs.
The docs don't mention that Vercel caches the favicon in the build cache and will not replace the file unless the build cache is invalidated or a different file is pointed to in the metadata.
Using any of the cache invalidation options at the link below will allow a favicon file to be updated after it has been deployed.
https://vercel.com/docs/deployments/troubleshoot-a-build#managing-build-cache