Skip to content

Docs impl#53

Open
ipmach wants to merge 34 commits intodevelopmentfrom
docs_impl
Open

Docs impl#53
ipmach wants to merge 34 commits intodevelopmentfrom
docs_impl

Conversation

@ipmach
Copy link
Contributor

@ipmach ipmach commented Feb 11, 2026

Add documentation to DetectMate.

@ipmach ipmach added enhancement New feature or request New feature labels Feb 11, 2026
@viktorbeck98
Copy link
Collaborator

ready to merge? @ipmach

@viktorbeck98
Copy link
Collaborator

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

@ipmach
Copy link
Contributor Author

ipmach commented Feb 12, 2026

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


Example of a configuration file:

```yaml
Copy link

@thorinaboenke thorinaboenke Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this config is outdated with #54 ? no more log_variables

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will adapt that

@ipmach
Copy link
Contributor Author

ipmach commented Feb 17, 2026

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.

@ipmach ipmach marked this pull request as ready for review February 17, 2026 14:24
on:
push:
branches: [ "main", "development" ]
branches: [ "main"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
branches: [ "main"]
branches: [ "main", "development"]

- name: Test with pytest
run: uv run --dev pytest -s

# include following code into the run section to match DetectMateService and DetectMateLibrary branches, if the name matches.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments