Lyceum Developer Wiki

To guide you in writing and reading suitable documentation, we separate our documentation with different tabs at the top into different business areas. Within each tab, our internal documentation should ideally follow the Diataxis approach ⧉, meaning a separation into guides, tutorials, explanations and references. This might first seem like a more verbose approach, but eventually helps with structuring and finding texts.

Warning

Articles not sorted into the categories guides, tutorials, explanations and references tend to be outdated and might require updates.

The menu structure can be found in the mkdocs.yml file at the documentations root. The first level are the tabs, followed by the nested, collapsed menu for the left-hand side.

In general, we aim to write programme code which describes itself. In this documentation, we do not want to dive into tiny details and and stay a bit further from the implementation details.