Structure of the Mono-Repo
In order to ensure uniformity of the HDTree meta-format, the various API implementations are kept within this mono-repo. Each implementation can cater to its language's strengths; nevertheless, the meta-format itself should unite all of the APIs.
For this reason, the different APIs will also be tested to make sure files written by one API can be read by others. Each API has its own subdirectory and it has full control over the organization within that subdirectory to conform to language conventions. So, in general, the structure of the mono-repo's root directory is very simple:
.github/
: GitHub workflows, templates, and other GitHub-related filestest/
: Integration tests to make sure files from one API can be read by anothercpp/
: CPP API ImplementationXlang/
: some language X API implementationmetaformat/
: documentation about the meta-format/schema itself, not specific to any languagedocs/
: general documentation about the HDTree projectREADME.md
: GitHub READMESUMMARY.md
: outline of mdBook-based documentation websitebook.toml
: configuration file for mdBook-based site