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

Update documentation / microsite #42

Closed
jdesiloniz opened this issue Nov 4, 2016 · 5 comments · Fixed by #146
Closed

Update documentation / microsite #42

jdesiloniz opened this issue Nov 4, 2016 · 5 comments · Fixed by #146
Assignees

Comments

@jdesiloniz
Copy link

We should take some time to update the docs and the microsite to reflect the changes that have been included in the library, maybe splitting the docs in several sections for the JVM and JS case uses.

@jdesiloniz jdesiloniz self-assigned this Nov 4, 2016
@jdesiloniz jdesiloniz removed their assignment Jan 11, 2017
@icassina
Copy link

how do you list pull requests with this library? no idea what the syntax is.

@fedefernandez
Copy link
Contributor

fedefernandez commented Apr 21, 2017

You're right, one of the main flaws of this project is the documentation. I'll try to, at least, organize the issues for documenting all operations.

In the meantime, you can always take a look at the tests where most of the operations are tested. For example, here there is an example of how to list the pull requests using the Id monad. There are implicits for Id, Eval and Future, as you can see here

@BenFradet
Copy link
Contributor

I'm planning on continuing to document the other APIs as well 👍

@juanpedromoreno
Copy link
Member

I believe this issue is almost done. I'd suggest doing a general editorial review of the documentation though, before releasing the 0.15.0 version. CC @anamariamv

@anamariamv
Copy link
Contributor

@MaureenElsberry could you review the documentation, before releasing the 0.15.0, please?

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

Successfully merging a pull request may close this issue.

7 participants