Skip to content

Restructure Manual & Introduce "Coding Conventions" Section

Simon Spannagel requested to merge restructure_manual into master

This MR picks up one of the suggestions from the workshop to better document coding guidelines and naming conventions. This is still work in progress as I might want to move more things to the "development" section, but it's a start and I'd appreciate some comments.

Two main changes:

  • All of "Files of a Module" has been moved form "Framework" to "Developing a new Module" since it makes more sense there
  • A new section "Coding and Naming Conventions" was added to the development section.

I have also included a copy of the classic "Koen's Coding Conventions" in the manual now, but I'm not sure yet if it's appropriate. Comments welcome. 😏

Merge request reports