Developers documentation

The current documentation is still fairly incomplete and high-level. It conveys the purpose of the new API and pipeline and it presents basic usage for the simplest use cases, which is a good way to start getting the attention of potential users, but at this point it still doesn't contain any relevant information for contributors: API internals, models, howtos for developers, configuration, etc.

This suggests that parts of the design are still in flux and not fully stabilized.

Any person that wants to contribute needs to read and understand the code, which also lacks proper documentation in most places. This is risky because a contributor might draw certain design conclusions from the code that may not be right or that could be provisional.

Adding a stable documentation for the API parts that are well established should be a priority to encourage external contributions.

Inizia con la documentazione attuale dell'API all'indirizzo https://kernelci.org/docs/api/ e confrontala con il codice dell'API per identificare le aree consolidate adatte alla documentazione per i contributori. Documenta gli elementi interni stabili dell'API, i modelli, le guide pratiche per gli sviluppatori e la configurazione; il lavoro sarà completato quando i contributori potranno comprendere queste aree e lavorarci senza dover fare affidamento soltanto sul codice.