You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Decide if we want/need to remove the old docs from the git repo @Dominik1999
...
How to check the API
I think the best way to do it is to go through the docs and verify that the arguments given to a specific API call is the same as in the rest.py file. Furthermore also checking that the returned json object has the fields specified in the api code.
The text was updated successfully, but these errors were encountered:
@czepluch can you manage that this issue get's closed soon? There will be no bigger changes in the Alderaan milestone anymore. Docs should be quite complete though
Dominik1999
changed the title
Make sure that docs.rainden.network is up to date with Alderaan
[META] Make sure that docs.rainden.network is up to date with Alderaan
May 20, 2020
Changing the content of the new docs is pretty straight forward. Just log into https://www.gitbook.com/ and choose the Raiden Network space to start adding content. I'll need to grant initial access to whoever wants to add stuff so just ping me about it.
Pay attention to how the current content is structured and written and try to keep the same style when adding new stuff. Some general guidelines:
Avoid walls of text, split the text into subsections that are easy to overview (see current content). This also makes it a lot more convenient when trying to find some specific information
Use bulleted lists with actionable steps written in an active voice whenever possible
Make technical stuff easy to understand. Both non-technical and technical people will appreciate this (win-win)
Graphics are nice when they make sense and they should follow the same principles as above
After we have made the Spec up to date with Alderaan, raiden-network/spec#252
The docs - https://docs.raiden.network/ - must be checked to make sure that it reflects all software related to the Alderaan Release.
List of changes
/shutdown
How to check the API
I think the best way to do it is to go through the docs and verify that the arguments given to a specific API call is the same as in the rest.py file. Furthermore also checking that the returned json object has the fields specified in the api code.
The text was updated successfully, but these errors were encountered: