Skip to main content

Proposed repository structure

D2.7 proposes one public framework repository. This is the intended layout, not a claim that all deliverables already exist.

README.md
CONTRIBUTING.md
CHANGELOG.md
<licence file>
docs/
methodology/
architecture/
taxonomy/
schemas/
specifications/
examples/
reference-components/
tests/
AreaIntended content and format
docs/methodology/Methodology, workflows and best practices in Markdown
docs/architecture/Reference architecture in Markdown with Mermaid/SVG diagrams
taxonomy/Definitions, generic mappings and core vocabulary in YAML/JSON/CSV
schemas/Generic data models in JSON Schema or YAML
specifications/Reporting package specifications and API/interface contracts, including OpenAPI
examples/Worked narratives and sample JSON
reference-components/Small validators, mapping utilities and example rules
tests/Validation cases and expected outputs

Current documentation site​

This repository hosts Docusaurus. Its documentation folders mirror these subject areas under docs/. A documentation section does not imply that corresponding machine-readable assets or executable code are available.

The existing taxonomy repository remains linked separately. Repository consolidation, visibility, licence selection and tagged framework releases require separate decisions.

Practicality test​

A developer should be able to understand the approach, inspect schemas, run an example and compare expected results without installing the platform. Reporting organisations should also be able to use the methodology and best practices to assess existing reporting processes.