Extension template documentation

This page serves to kickstart the development of your extension and provide guidance in the process. Once confident with the whole process, please delete the content of this page and replace it with an introductory description of the extension, comprehending its context, scope and objectives.

The documentation must be written in Markdown and will be compiled automatically using Jekyll against the Just the Docs theme. Each time you git push your local commits on the remote repository, a GitHub action will wake up and take care of CD/CI. Once compiled successfully, your documentation will be deployed on GitHub Pages on the SKG-IF website, despite being initially hidden in the left-hand-side menu. Please follow the indications and the examples provided and feel free to customise it as long as it complies with the overall workflow. For debugging purposes, the execution of GitHub actions can be monitored here.

Documentation checklist

In order to document the specification introduced by your extension, please use the suggested folder structure. In particular, the document you have to produce has to cover these fundamental aspects:

• Production of the extension data model and formal implementation in OWL;
• Production of the SHACL file;
• Production of the JSON-LD context for the extension;
• Description of the extended Interoperability Framework (properties and relations of core and new entities);
• Provide APIs extensions of the core OpenAPI specs; i.e., customisations of core API resolvers (if any) and/or introduction of custom API methods (if any);
• Production of JSON-LD examples.