Developer Documentation

[rettichschnidi]

I (and others too) think Wakaama should work on offering great developer documentation in order to simplify on boarding of new developers, committers and improving the maintainability of the project.

For the technical part, my suggestion would be:

• Developer documentation: Sphinx
  • Built for every commit, available as artifact
  • Most recent build for master deployed to https://www.eclipse.org/wakaama/ (or a subdirectory?)
• Source code: Doxygen
  • Built for every commit, available as artifact
  • Most recent build for master deployed to https://www.eclipse.org/wakaama/doxygen (?)

Initial Content:

• Content of README.md (which needs to be reworked then to make sense again)
• examples/bootstrap_server/README
• Unsure if sensible: Landing page currently hosted at https://www.eclipse.org/wakaama/ (updated where necessary)
• Some examples for stuff we have already and will be discussing in the meantime.

The structure of the documentation I have no idea yet, but I think we can discuss this once the technical aspects have been agreed on and resolved (minus the deployment part).

What do you think?

[tuve]

As we are adding static analyzing, linting etc as part of the ci I think we should document that as well and to what extent it is possible to perform checks locally before creating a pull request.