Update branch and baseline docs #325
Merged
Conversation
This file contains 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
elseloop
approved these changes
Nov 29, 2023
| @@ -121,7 +118,7 @@ You can see the ancestor builds listed on the build page: | |||
|
|
|||
|  | |||
|
|
|||
| #### Calculating a snapshot baseline from the ancestor build(s) | |||
| #### Calculate a snapshot baseline from the ancestor build(s) | |||
|
|
|||
| Once we’ve got the ancestor builds for a build, the algorithm to calculate the baseline for any given snapshot goes like this: | |||
There was a problem hiding this comment.
This may not be for this PR—this isn't part of your changes—but I wonder if this description of the baseline algorithm should be an (un)ordered list or otherwise grouped together semantically and/or visually?
There was a problem hiding this comment.
Also, in the first line below, should “viewport combination” be “mode” instead?
There was a problem hiding this comment.
I updated the copy to "mode".
Tell me more about the unordered list/grouping? If it's easy let's do it here.
There was a problem hiding this comment.
I'm going to merge this to expedite the updates. Let's do a follow up PR if we want to change this section (assign me as a reviewer!).
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.
https://linear.app/chromaui/issue/DX-789/docs-simplify-branches-and-baselines-page
Edit the baseline docs for coherence. I changed the perspective of the doc from baselines (a UI Tests centric pov) to how UI Tests and UI Review work with snapshots.
The copy is up to date, but I need to add one image.