Documentation

[apdavison]

We need documentation for three classes of user:

1. viewers - just want to look at the data
2. website developers - want to embed the component in their website
3. service hosts - want to deploy their own instance of the REST API service

Decision needed: where to host each type of documentation, and whether to have all documentation in one place (simpler but potentially confusing) or separate.

• https://neo-viewer.brainsimulation.eu/
• Github pages
• ReadTheDocs

[xgui3783]

I would argue that:

1/ on https://neo-viewer.bransimulation.eu
2/ on https://neo-viewer.bransimulation.eu and github
3/ on https://neo-viewer.bransimulation.eu and github (and ReadTheDocs? Coming from the non-python background, I often find myself on github for documentations)

It probably does not hurt to have hyper links (e.g. on github, a link pointing to neo-viewer.brainsimulation.eu for users who just want to look at data)

If the documentation is in markdown/rst, github can automatcially display them formatted. Turning them into HTML pages should be relatively simple, too.