-
Notifications
You must be signed in to change notification settings - Fork 74
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
Add basic layout system documentation. #1739
Conversation
@@ -0,0 +1,3 @@ | |||
version https://git-lfs.github.com/spec/v1 |
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.
These are in LFS. Do we want to change our rules so only screenshot tests go into LFS? Or are we okay sending all pngs?
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.
Hmm I don't have a strong opinion. I imagine the docs are going to either be viewed on github.com, which correctly renders the images inline, or on the published docs site, which will host the images. Is there a downside to storing these with LFS?
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.
Mostly just philosophical. It breaks the concept of a self-contained repo. The screenshot test goldens can be refreshed by running the tests. These are more like part of the codebase.
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.
Good point, I'll clean up the code that generates these screenshots and add it to the repo.
Going to follow up with visual documentation for modifiers.