intuit / intuit/postcss-themed

Clean Up ReadMe Documentation

Open
#24 2 comments 0 reactions 0 assignees View on GitHub
enhancement hacktoberfest
Dominant language
TypeScript
Stars
61
Forks
30
PR merge metrics
No merged PRs in 30d

Description

Right now the documentation in the ReadMe is a little hard to follow and could use some improvements. I think it would be helpful to:

- Break apart the `modern` and `legacy` generation into separate sections which explain the differences in how they work and how you use them.
- Create a legend at the top of the readme that links to individual configuration options or examples.
- Clean up headers and documentation text.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.