Skip to content

Set up documentation for automated CI #86

@ernstleierzopf

Description

@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.

Metadata

Metadata

Labels

deliverableAdd this label if this is for a deliverabledocumentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is neededpython:uvPull requests that update python:uv code

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions