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 an mdBook for Interledger.rs #240

Open
emschwartz opened this issue Aug 22, 2019 · 3 comments
Open

Create an mdBook for Interledger.rs #240

emschwartz opened this issue Aug 22, 2019 · 3 comments
Labels

Comments

@emschwartz
Copy link
Member

Once the design and API settle down a little more it would be great to write an mdBook to document the various parts of this project and how to use it.

@sappenin
Copy link
Contributor

Not sure if there are specific reasons for you to use mdBook, but I've had good experience using GitBook. It's actually really pleasant to use their app for team editing, too.

WIP output is here: https://java-connector.ilpv4.dev

@dora-gt
Copy link
Member

dora-gt commented Aug 29, 2019

↑looks so nice😳

@gakonst
Copy link
Member

gakonst commented Nov 9, 2019

Ping on this, floated the thought of removing the E2E examples and just distribute the book. This will remove all the code duplication we have in the examples, and give a complete narrative around how ILP.rs is structured. A section would be dedicated on setting up, and the other sections would be playing out each scenario.

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

No branches or pull requests

4 participants