Set up documentation for automated CI

[ernstleierzopf]

Set up documentation for DetectMateService with configurations in separate files outside of the md file.

MkDocs allows to include external files when generating documentation.
This could be done like this:

--8<-- "configs/example.yaml"

or even with multiple files:

--8<-- "configs/example.yaml"
--8<-- "configs/example2.yaml"

You can also create sections of the configs, if you only want to reference specific parts:

# --8<-- [start:service]
version: 1
# --8<-- [end:service]

and then:

--8<-- "configs/example.yaml:service"

This would allow an easy way to test important parts of the documentation in CI and fix outdated documentation immediately, the same way we tried to do it with the AMiner.

[ernstleierzopf]

@ait-detectmate/core I know the documentation is just evolving at the moment, but please let me know what you think about this idea, so we can create documentation with this in mind.

The same applies to DetectMateLibrary documentation.

[whotwagner]

Good idea. You can restructure the docs. I would be delighted if the docs get a proper structure

[viktorbeck98]

I agree, that would be very nice