Skip to content

Extend the documentation

The Documentation i.e. in README.md is outdated or incomplete. The same goes for the general docs folder.

Possible Solution

Make a blocker and rework/extend the documentation. This is especially critical when the data models that we use here at the IEK-10 go public.

Docs that need some work are:

  • README.md
    • This should also include badges like supported python versions, current coverage, test status and so on
  • /docs/nomenclature.md
  • add a README.md to /docs/ that works as a table of contents and general overview
  • /docs/normalized.md should be filled