adeo / mozaic-design-system

Mozaic Design System
https://mozaic.adeo.cloud
Apache License 2.0
69 stars 17 forks source link

Improve documentation on grid system #1487

Open sbrauch opened 11 months ago

sbrauch commented 11 months ago

I want to propose an evolution/improvement on

Documentation

Description

I've just recently implemented the grid system into our project and I had a bit of trouble with it. I want to point out that my suggestions are only improvements as it was entirely my fault that I struggled a little bit.

Would it be possible to change two points in the documentation?

1 / Columns options Maybe it would be a good to highlight the "1of4" modifiers etc... columns to make it clear that it doesn't follow the "of12" rule any more at a certain point. I was used to the 3of12 etc... that I kept missing this point in the documentation.

2/ Important CSS style It should be common knowledge that we might need to add box-sizing: border-box to the element inside the column to make the solution work properly. Nevertheless, would it be possible to add this point to the documentation for others to not miss it any more in the future?

Describe the solution you would like

1 / Columns options

2/ Important CSS style

Describe the alternatives you considered

No response

Additional comments

I know that you'll be adding a new breakpoint soon. My suggestions could be added at the same time :)