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

Is better documentation needed? #158

Open
gaurav21r opened this issue Aug 5, 2014 · 7 comments
Open

Is better documentation needed? #158

gaurav21r opened this issue Aug 5, 2014 · 7 comments

Comments

@gaurav21r
Copy link

Guys, first of all. Great job! This is a fantastic framework! 👍

As this is the port of impress.js there is one essential feature missing I think which will also contribute to jmpress.js 's development from the community.

The inline code documentation is certainly very very lacking although there is a good modular architecture. Compare it to the no so modular but beautifully documented https://github.com/bartaz/impress.js/blob/master/js/impress.js

My team and I can work on inline documentation and send Pull Requests. But I wanted to conform from @sokra @shama whether they would be open to such a thing as I don't want our efforts to goto waste.

Personally, it took me quite some time to get around the code before I could contribute. Its certainly intimidating!

@sokra
Copy link
Member

sokra commented Aug 6, 2014

Sure you can work on documentation. 👍 We'll comment on and merge your PRs.

@sokra
Copy link
Member

sokra commented Aug 6, 2014

If you have any question about code fragments, feel free to ask.

@JJ
Copy link

JJ commented Sep 11, 2014

Totally. I do have to work a lot through examples to get something done.

@ramboldio
Copy link

👍

@FagnerMartinsBrack
Copy link

Any news on this one?

@gaurav21r
Copy link
Author

Whoops, got busy with other projects! But definitely in my radar. Anyone else interested in contributing to this? We can share the workload.

@JJ
Copy link

JJ commented Dec 27, 2014

Count me in if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants