search

bly-th / css-website

GNU General Public License v3.0
1 stars 1 forks source link

Utility descriptions #3

Closed husseinalhammad closed 3 years ago

husseinalhammad commented 3 years ago

I think it would be helpful to have more descriptive definitions of each utility in the docs. At the moment all utilities are described as:

Our {name} utility is constructed as follows:

ryangittings commented 3 years ago

Completely agree. Plans are in place to upgrade the documentation, purpose and examples of utilities.

ryangittings commented 3 years ago

Now drafted, https://github.com/bly-th/css-website/pull/4 / https://deploy-preview-4--blythcss.netlify.app/

It does need a refining, but good to get something drafted on this as it's quite an important part of Blyth! See what you think.

husseinalhammad commented 3 years ago

Thanks, @ryangittings! This is very helpful.

Auto Grid

I think the long paragraph of the --auto-grid-min explanation under the purpose section is a little hard to read. Perhaps it would be easier to read if --auto-grid-method and --auto-grid-min were h3s so the explanation of each can take as many paragraphs as needed.

ryangittings commented 3 years ago

Hopefully improved with https://github.com/bly-th/css-website/commit/6d7a64c7615863075ee918c858abe7d3e41c9810

husseinalhammad commented 3 years ago

Looks great! Thank you