Split existing tutorials up into documentation on different levels - Githubissues

Materials-Data-Science-and-Informatics / metador-core

Core of Metador, the FAIR metadata-first research data management framework.

MIT License

4 stars 0 forks source link

Split existing tutorials up into documentation on different levels #71

Open apirogov opened 2 years ago

apirogov commented 2 years ago

Currently, the Notebooks are in the uncanny valley between various kinds of documentation, while being not fully satisfactory on any single "level".

They should be broken apart and cross-linked.

There should be:

concepts (high abstraction level)
tutorial, bite-sized examples (concrete, copy-paste-able)
mid-level manual (explanation beyond what is in the docstrings)
automatic docs (the technical reference, generated from docstrings)
pure user docs (for users not writing code)