Skip to content
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

Merged
merged 6 commits into from
Dec 13, 2023
Merged

Conversation

colinrtwhite
Copy link
Member

Going to follow up with visual documentation for modifiers.

redwood-layout-schema/README.md Outdated Show resolved Hide resolved
redwood-layout-schema/README.md Outdated Show resolved Hide resolved
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
Copy link
Collaborator

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?

Copy link
Member Author

@colinrtwhite colinrtwhite Dec 13, 2023

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?

Copy link
Collaborator

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.

Copy link
Member Author

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.

@colinrtwhite colinrtwhite merged commit 96ab194 into trunk Dec 13, 2023
8 checks passed
@colinrtwhite colinrtwhite deleted the colin/layout_docs branch December 13, 2023 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants