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

Needs improved documentation #4

Closed
westonganger opened this issue Sep 4, 2016 · 5 comments

Comments

Projects
None yet
2 participants
@westonganger
Copy link

commented Sep 4, 2016

I really like what this repo has to offer however some better documentation would serve the project well.

The readme should start with a basic description of what it is and what it does with bullet points of the features it implements.

Also right now it kind of seems like a black box. I had to dig through the code to see whats it is all about. I see there are many unexplained directives, sign in functionality, etc. Some explanation of all of these items would really promote use of this.

@storuky

This comment has been minimized.

Copy link
Owner

commented Sep 4, 2016

Good call, @westonganger. I'll try to structure it this weekend.

@storuky

This comment has been minimized.

Copy link
Owner

commented Sep 4, 2016

Done
Let me know if you have questions or feedback.

@storuky storuky closed this Sep 4, 2016

@westonganger

This comment has been minimized.

Copy link
Author

commented Sep 4, 2016

Oh man that's good stuff. Now I can get on board with this. My only comment is I can't really read the documentation on my phone because the side nav doesn't have a toggle button to hide/collapse it.

@storuky

This comment has been minimized.

Copy link
Owner

commented Sep 4, 2016

@westonganger, check it now:)

@westonganger

This comment has been minimized.

Copy link
Author

commented Sep 5, 2016

Beauty! I think you've improved this a lot this weekend. Thanks for all your hard work for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.