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

[META] Make sure that docs.rainden.network is up to date with Alderaan #3775

Closed
10 tasks done
czepluch opened this issue Apr 9, 2019 · 4 comments
Closed
10 tasks done
Assignees
Labels
Milestone

Comments

@czepluch
Copy link
Contributor

czepluch commented Apr 9, 2019

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

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.

@Dominik1999
Copy link
Contributor

@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

@czepluch
Copy link
Contributor Author

I think the responsibility of this has been moved to Talel. But I will check up tomorrow.

@konradkonrad
Copy link
Contributor

konradkonrad commented May 12, 2020

there is a new api endpoint named /shutdown

@Dominik1999 Dominik1999 changed the title Make sure that docs are up to date Make sure that docs.rainden.network is up to date with Alderaan May 20, 2020
@Dominik1999 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
@taleldayekh
Copy link
Contributor

taleldayekh commented May 25, 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

Let me know if there are any questions.

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

6 participants