Contributing documentation

[ewjoachim]

trafficstars

Our current contributing documentation is really oriented toward the process of contributing. It would be interesting to also document the architecture and codebase itself.

Following a suggestion from @xcambar, there would be interest in documentation on:

• The SQL (the tables, the procedures, the triggers etc)
• What would be needed to port procrastinate to a new language while keeping DB compatibility

Also, we could be more explicit about:

• The App as the center of the architectural design
• The role of other parts
• The connectors, and how they interact with the app
• How the responsibilities are dispatched between the different bricks.

This could be party documented in the code directly, but the code documentation is currently used for the public API, so either we change that or we document elsewhere.