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

Improve documentation #61

Open
zawadz88 opened this issue May 2, 2019 · 0 comments
Open

Improve documentation #61

zawadz88 opened this issue May 2, 2019 · 0 comments

Comments

@zawadz88
Copy link
Owner

zawadz88 commented May 2, 2019

Currently, the only documentation available is in Github README. There's also Github Pages with Dokka documentation and a sample app with most APIs covered, but it feels to me that the documentation should be better.
There were many new features added recently (https://github.com/zawadz88/MaterialPopupMenu#supported-features) but the documentation in README does not cover it at the moment.

A better, more organized documentation might decrease the initial learning curve and make finding available APIs easier. It should probably be moved to Github pages - I don't feel like we should clutter README too much.

Ideally, I would like to have README similar to this https://github.com/aalmiray/kordamp-gradle-plugins and wiki page generated by Asciidoctor like here: https://aalmiray.github.io/kordamp-gradle-plugins/

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

No branches or pull requests

1 participant