Skip to content
This repository has been archived by the owner on Apr 23, 2024. It is now read-only.

Documentation is meh #12

Open
mariosant opened this issue Feb 21, 2019 · 3 comments
Open

Documentation is meh #12

mariosant opened this issue Feb 21, 2019 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@mariosant
Copy link
Owner

Documentation is currently not very helpful. How could this project do better?

@mariosant mariosant added the help wanted Extra attention is needed label Feb 21, 2019
@george-aidonidis
Copy link
Collaborator

george-aidonidis commented Mar 2, 2019

How about a side to side comparison with the boilerplate that this module helps with? 🤔
This can be either in readme as a codeblock snippet or even a codepen 😮

I can come up with something in the next days if you like this plan

@mariosant
Copy link
Owner Author

That would be great @george-aidonidis, thanks! I was thinking about having a documentation site somewhere, even if it's a simple page. Thoughts?

@george-aidonidis
Copy link
Collaborator

Yeap, sounds like a plan. There are some packages that generate doc sites if that helps (like this or this

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants