chore: additional explanation if prerender fails#1849
Open
Conversation
Updated error message to include cache deletion instructions.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
|
Ha, there's a reason this is one of computer science's two hard things #1841 (review) |
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.
@Rich-Harris if we update a type definition without changing a documentation page which uses it in a code block, twoslash will reuse a cached version of the code block that references an id which may no longer exist. This will cause the prerendering to fail with "this page referenced an ID that does not exist".
This PR adds remediation steps if the prerendering ever fails and that is the case
EDIT: In hindsight, I wonder if this means there are pages which do not update their codeblock rendered "types on hover" when we update their types. Maybe we need to ditch caching entirely or just make sure to invalidate the cache when deploying on main
Before submitting the PR, please make sure you do the following
feat:,fix:,chore:, ordocs:.