Skip to content

Documentation for Getting started with the Raiden API#721

Merged
LefterisJP merged 8 commits intoraiden-network:masterfrom
czepluch:update_install_and_usage_documentation
Jul 16, 2017
Merged

Documentation for Getting started with the Raiden API#721
LefterisJP merged 8 commits intoraiden-network:masterfrom
czepluch:update_install_and_usage_documentation

Conversation

@czepluch
Copy link
Copy Markdown
Contributor

@czepluch czepluch commented Jul 12, 2017

This fixes some small errors in Overview-And-Guide.rst and Rest-Api.rst

It's main focus is to write a user guide for the API endpoints in accordance to #668

@czepluch czepluch force-pushed the update_install_and_usage_documentation branch 3 times, most recently from ca1358c to 7751a79 Compare July 14, 2017 18:58
@czepluch czepluch changed the title Initial work on updating the Raiden documentation Documentation for Getting started with the Raiden API Jul 14, 2017
@konradkonrad konradkonrad mentioned this pull request Jul 14, 2017
12 tasks
czepluch and others added 8 commits July 16, 2017 11:00
This fixes one small error in Overview-And-Guide.rst

It's main focus is to write a user guide for the API endpoints.
This commit finalizes the first draft of the section explaining how
bootstrap a token network for a not already registered token.

Furtermore it fixes a small "bug" in the API doc where the same address
is used for a channel and a channel manager
@LefterisJP LefterisJP force-pushed the update_install_and_usage_documentation branch from 7751a79 to 3859fb9 Compare July 16, 2017 09:38
@LefterisJP
Copy link
Copy Markdown
Contributor

Made some fixes in the documentation and looks good to me.
We still need to adjust the Makefile and make sure that the documentation builds better. The documentation builds but there are errors and also files outisde the _build directory. Will try to take care of that myself.

@czepluch two notes about documentation in restructured text:

  1. Your in document links with :ref: were fine but you need to have a blank line between the anchor and the title. e.g.:
.. _joining-existing-token-network:

Joining an already existing token network
=========================================
  1. The external document links should not have the .rst extension or have the directory specified. It can be found by the sphinx document builder and it needs to not have an extensions since docs also get compiled to html and pdf. e.g.:

please see :doc:`Overview and Guide <Overview-And-Guide>

@LefterisJP
Copy link
Copy Markdown
Contributor

Will merge this and further work can happen in other PRs.

@LefterisJP LefterisJP merged commit bae7dbc into raiden-network:master Jul 16, 2017
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 this pull request may close these issues.

3 participants