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

Create documentation site for the v1/v2 REST API #12

Open
nijynot opened this issue Feb 21, 2019 · 5 comments
Open

Create documentation site for the v1/v2 REST API #12

nijynot opened this issue Feb 21, 2019 · 5 comments
Labels
help wanted Extra attention is needed

Comments

@nijynot
Copy link
Member

nijynot commented Feb 21, 2019

Grin has a REST API - for the node and for the wallet (foreign and owner).

Might make sense to turn the documentation of the REST API into a proper documentation page, similar to e.g. Stripe's API Reference or maybe Coinbase's.

Having fully fleshed out documentation with examples of expected responses should make it easier for future devs to build things on top of Grin. Maybe even adding installation, basic usage on the same site, just to make it easier to navigate through the docs.


Thinking that something like https://github.com/lord/slate would fit our needs pretty well.

Waiting for Grin's v2 API (mimblewimble/grin#2425) to land before going forward with this might be a good idea. Anyways, anyone free to pick this issue up if they feel like helping out!

@nijynot nijynot added the help wanted Extra attention is needed label Feb 27, 2019
@aisha-w
Copy link

aisha-w commented May 29, 2019

hello, are you still looking for help on this? i can use slate to convert your current docs into something nicer to read.

@nijynot
Copy link
Member Author

nijynot commented May 29, 2019

Yup, issue still open to be picked up!

I know there exists some V2 documentation for the grin-wallet somewhere, which would be nice to have in a "slate" doc format instead. That's the part of the doc which I think should be converted for now, as V2 api does not exists for the node yet.

@Quadrisheriff
Copy link

Hello, do you still need help with this?

@Brennakm
Copy link

Brennakm commented Jul 5, 2020

Hi! I'd like to help create the API documentation. Let me know if this is something you still need done. Thanks.

@calidoclette
Copy link

Hello, let me know if you need help creating API documentation!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants