Docs: Add snapshot section and how to update theme-preval snapshosts
#2950
Conversation
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
|
broccolinisoup
requested review from
colebemis,
joshblack,
langermank and
mperrotti
Contributor
size-limit report 📦
|
broccolinisoup
temporarily deployed
to
github-pages
GitHub Actions
Inactive
colebemis
approved these changes
Feb 28, 2023
Contributor
colebemis
left a comment
colebemis
left a comment
There was a problem hiding this comment.
Thanks, @broccolinisoup ✨
joshblack
approved these changes
Feb 28, 2023
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 came up in a conversation while trying to resolve CI issues on @mperrotti's PR and we got to realise that we don't have docs on how to update the
theme-prevalsnapshots. So I added aSnapshotssection and documented that, while I was already there, added some info about our direction of moving away fromJestsnapshots.After updating the
theme-prevalsnapshots, @langermank unexpectedly saw a bunch of snapshots are in the diff in her PR and we resolved the issue by making sure we have re-built the components on our locals. So I added that bit to the FAQ.Let me know what you think 🙌🏻
Screenshots
No visual changes
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.