documentation

[EBB2675]

No description provided.

[ndaelman-hu]

I like the chapters "Hierarchical ModelSystems" and "Normalization Workflow" best, since they give me an idea of what this tool models, how to use it, and what it means to normalize it. I'd actually prefer them more fleshed out.

Conversely, these tables should probably be listed in a reference.md. They can also be automatically generated, e.g. via

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            show_docstring_attributes: true
            docstring_section_style: table

[ndaelman-hu]

I thought it was clear here that these can be later on.
Wouldn't forget the references, though. Especially given the amount of information in the pydocs that @EBB2675 added.

[JFRudzinski]

I would like to merge as much work as possible before next week. I see no reason why this can't be simply merged. If these review notes are still relevant, I would suggest opening an issue that points to these and then merging this PR