[Task] Check and publish the JSON Schema definition

[taorepoara]

What should be done

In order to make it checkable and simple to understand, create a JSON Schema of the configuration file and publish it to SchemaStore to allow auto-completion in IDE.

Technical recommandation

There are two ways to add the schema:

• include it into the repo and update it through PRs
• include a link to the self-hosted schema

IMO, the best may is to generate the schema and include it into the release artifacts, and define it as self-hosted with the latest release artefact as URL.

Ecological concerns

It might be better to have a single file instead of merging it at release time since it might not change a lot, but generating the schema with schemars would avoid errors.

Is this task linked with any other ?

[taorepoara]

Be careful to enum generation. It doesn't seems to work fine

[taorepoara]

Also upgrade the README documentation

[taorepoara]

The best way would be to generate Markdown from JSON Schema or create a documentation website with docausorus: https://json-schema.org/implementations#documentation-generators

[taorepoara]

Might be interesting of renaming the definition with serde or schemars rename attribute: https://graham.cool/schemars/deriving/attributes/#rename
And also, adding some examples with the example attribute: https://graham.cool/schemars/deriving/attributes/#example

[taorepoara]

Renaming is done.

A markdown generation could be nice:

bunx @adobe/jsonschema2md --input docs -n -o docs/schema

This needs to imrpove custom schemas (VecPatch, ParsableStruct...) to use $ref

[taorepoara]

Full doc generation:

mkdir -p docs
cargo run -F cli -F json-schema -- schema > docs/dofigen.schema.json
sed -i -E 's/("[$]ref"[:] ")/\1.\/dofigen.schema.json#/g' docs/dofigen.schema.json
bunx @adobe/jsonschema2md --input docs -n -o docs/schema

The generated doc is not great...