BlackbirdDigital / wp-theme-scaffold

Blackbird's WordPress Theme Scaffold
GNU General Public License v2.0
30 stars 1 forks source link

Better documentation for Sass tools & settings files #30

Open cr0ybot opened 2 years ago

cr0ybot commented 2 years ago

The README file doesn't go into much detail about the settings and tools folder in src/styles. The settings/_theme.scss file in particular can be pretty powerful if you understand how it works and how it relates to the theme.json's custom property, and is kindof the crux of this entire scaffolding (or at least the styles anyways).

Should the README be expanded to include more details? I feel like it needs at least a little bit more to explain that these are important/useful, and could link off to other more detailed README files.

Aside from that, the files themselves could use more robust documentation in the file header/comments.