Docs impl

[ipmach]

Add documentation to DetectMate.

[viktorbeck98]

ready to merge? @ipmach

[viktorbeck98]

There's multiple speeling issues, pls correct them or ask copilot to resolve them @ipmach

[ipmach]

There's multiple speeling issues, pls correct them or ask copilot to resolve them @ipmach

yeah I know, this is currently a draft PR. It is not ready for review

[ipmach]

Ok, now the branch is ready to review. However:

• We need to find a way to make sure that the code examples always work without too many manual work (the docs will increase in the future).
• The pages "Basic usage" and "implement new component" are missing.

[thorinaboenke]

this should not be removed. This section determines which version of the DetectMateService should be pulled in for testing. If you are on main, it sets the service branch to main. Otherwise, it defaults to development.

[ipmach]

Ok, I think all comments have being address and we can merge the branch. Otherwise let me know :)

[thorinaboenke]

Suggested change

	uv pip install -e .[dev]
	uv sync --dev

both create a working development environment, but uv pip install only adds packages to the existing state, uv sync --dev will automatically automatically sync the environment with the lockfile

[thorinaboenke]

Nice docs!
please use uv sync --dev with a uv.lock file instead of uv pip install -e .[dev] (sry, did notice in my last review!)
and ensure pytest in python-app.yml matches library and service branches (or reason the changes, maybe I missed something?)

[ipmach]

Nice docs! please use uv sync --dev with a uv.lock file instead of uv pip install -e .[dev] (sry, did notice in my last review!) and ensure pytest in python-app.yml matches library and service branches (or reason the changes, maybe I missed something?)

Thanks! I updated the manual for the uv sync --dev part. I also modify the pytest command so is identical to the one use in the python-app.yml.