Skip to content

Add Documentation

Documentation needs to be added to the tool:

  • installing
  • getting started/running on a sample dataset (sample dataset using sdc as a data source (download data from web, extract, run grisviewer)
  • overview of features
  • which requirements are there for data (e.g. l1 translated data)

Places where the documentation needs to be referenced:

  • readme.md
  • Entry to code overview page on confluencehere
  • Short info/landing page as a child for documentation in the manuals page

Do you want to use gitlab pages and readthedocs for documentation? This probably spawns a lot of smaller sub-issues, @guenter has a proof of concept to use gitlab pages and runners to automatically build and deploy the documentation. It might be more suited to technical/developer documentation, but definitely best practice.

  • evaluate and plan readthedocs and gitlab pages strategy
Edited by Carl Schaffer