📄 Generate documentation for ontology schemas in markdown format

[ccamel]

Purpose

As a OKP4 builder, I would like to have a comprehensive documentation of the ontology, so that I can easily understand the concepts, relationships, and properties defined in the ontology. This documentation is commited in the project.

The idea is that the generated documentation is then aggregated in the OKP4 docusaurus documentation site, as is already done for the okp4d and contracts projects.

Todo

• Implement the generation of the markdown version of the ontology schema, using for instance python and rdflib:
  • Organize the documentation in a clear and concise manner, with sections for the ontology's purpose, classes, properties, and relationships on one side, and on the other side the vocabularies expressed in SKOS.
  • This feature should be added as a new target in the Makefile.
• Use the diagrams generated (implemented by 📄 Generate diagrams for the ontology #111)
• Integrate a CI job to verify that the generated documentation is always up-to-date with the latest version of the ontology.
• Include instructions for users in the repository's README on how to generate the documentation.

[ccamel]

This issue is starting to become urgent because the ontology is becoming increasingly substantial, and we need documentation support and schemas to fully understand it. This is necessary for the front-end developers, blockchain developers, product team, and marketing communications.

[ccamel]

I have separated the generation of the actual images in another ticket #111.

[ChaimaaZaoui]

@ccamel can you tell me if this ticket has started ? urgent one month ago ? should I re-prioritise it ?

[ccamel]

@ChaimaaZaoui This ticket is indeed urgent, as there is an urgent need for the most complete possible documentation for developers and builders, in line with @antho31's initiatives on this subject.