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

Documentation: Grid should be an example, not a style #273

Closed
shai126 opened this issue Dec 1, 2017 · 1 comment
Closed

Documentation: Grid should be an example, not a style #273

shai126 opened this issue Dec 1, 2017 · 1 comment

Comments

@shai126
Copy link

shai126 commented Dec 1, 2017

It seems to me that the styles section of the documentation is for learning about all the available utilities, and then examples shows how you can compose multiple utilities to make cool stuff.

I've now seen a couple of developers get confused when they try to figure out grids—and can't get their head around what's special about the md:w-1/3 class that makes it suitable for grids, and what other "grid utilities" are available.

I wonder whether this is a result of grid being listed in the styles section of the docs. Shouldn't grid be categorized under examples? It just composes flex, sizing and responsive utilities – it's no more a part of Tailwind than buttons or alerts are.

Or, if not, a note in the grid docs to explain that it's just comprised of whatever flex and sizing and responsive utilities you want to use.

@adamwathan
Copy link
Member

Yep improving this has been on my radar for a while but just no time to do it yet. Definitely want to move it to examples and change all of the examples to look like all the other code examples in the docs; the grid docs were actually one of the very first things I quickly hacked out before we had any patterns in place for how we were going to do things.

I'll see if I can improve this today.

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

No branches or pull requests

2 participants