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.

Sign up for GitHub

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

Jump to bottom

Library documentation. #18

Open
pedrovgs opened this issue Sep 14, 2016 · 1 comment
Open

Library documentation. #18

pedrovgs opened this issue Sep 14, 2016 · 1 comment
Labels
library usage

Comments

@pedrovgs
Copy link
Member

pedrovgs commented Sep 14, 2016 •
edited
Loading

As the project is going to be published as an open source project we need to document the library usage and the internal behaviours and a FAQs section. Evaluate if a wiki is needed and create a github page with the readme content if needed. Review if the documentation has to be also published in the project website.
@pedrovgs pedrovgs added this to the 1.0.0 milestone Sep 14, 2016
@pedrovgs
Copy link
Member Author

Just javadoc. We don't need the README.md project yet.

@pedrovgs pedrovgs removed this from the 0.0.6 milestone Oct 17, 2016
@pedrovgs pedrovgs added this to the Release 0.2.0 milestone Nov 4, 2016
@pedrovgs pedrovgs removed this from the Release 0.2.0 milestone Nov 23, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
library usage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pedrovgs