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

Clean Up ReadMe Documentation #24

Open
tylerkrupicka opened this issue Sep 30, 2020 · 2 comments
Open

Clean Up ReadMe Documentation #24

tylerkrupicka opened this issue Sep 30, 2020 · 2 comments
Labels
enhancement New feature or request hacktoberfest

Comments

@tylerkrupicka
Copy link
Contributor

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.
@tylerkrupicka tylerkrupicka added enhancement New feature or request hacktoberfest labels Sep 30, 2020
@anjaliguptaz
Copy link

@tylerkrupicka Is this still valid and needs to be done ?

@anchal0997
Copy link

Hi @tylerkrupicka, I would like to contribute to this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants