Repository navigation
New documentation - #301
Merged
Merged
Conversation
… again in the docu; fix some grammatic mistakes
viktorbeck98
requested changes
Sep 22, 2026
Contributor
Author
|
Note: I removed the |
…he automate function for the configuration arguments for the documentation
…r the documentation
… the automate function for the configuration arguments for the documentation
…ield function and the automate function for the configuration arguments for the documentation
… the automate function for the configuration arguments for the documentation
3 of 5 tasks
ipmach
requested changes
Sep 28, 2026
Contributor
There was a problem hiding this comment.
Hi overall looks good,
Main issues I see are:
mkdocs-materialis missing in dependencies and it will not run locally.- Visual wise looks different from the Service because you change the theme. We may need to talk with Hoti and Thorina about that.
- I think the argument tables should add all arguments. Because that is a critic that we are currently getting from people, that they don't know what arguments should be given to the detectors.
auto_configand data use in training and so on should be listed in every detector etc... Also detectors like the combo detector is missing certain arguments in the table like combo size. - You forgot to put your name in the
metadata.py
- docs tables now show all arguments per component, grouped by YAML block (top level / params / auto_config_params) in collapsible sections, with a Scope column marking detector-specific vs shared fields and changed defaults - get_docs() expands auto_config_params (nested fields as dotted names) and documents persist; field descriptions added where missing - generated YAML examples include auto_config_params and are checked to load back; event_sequence.md is now generated too (its hand-written YAML was wrong) - add mkdocs-material to dev dependencies, enable admonition/details - add Leonhard Kaufmann to authors, fix dead tutorial link
Every parser and detector page now shows a hand-written configuration file that sets only what its use case needs, loaded by the page's Python example so the snippet tests keep it valid. The full-defaults YAML block generated by update.py is removed; all parameters remain in the generated argument tables, with auto_config_params collapsed by default. - detector examples train on realistic sshd logs and print a real alert (combo now uses two variables) - pages reordered: At a glance, Description, Example, Configuration file, Configuration arguments - fix the broken YAML in detectors.md and warn that data_use_training / data_use_configure must be set - move auto-config implementation internals to development.md - fix the duplicated Drain example and drop the redundant LogBatcher one
- number detectors 00-12 in the sidebar, ordered from simplest to most complex, and note the ordering in the detectors overview - align page titles and prose (Rule Detector, New Value Combo Detector, DeepLog, LogBERT, JSON/Drain Parser, Template Matcher) - rename deeplog/logbert example files to match their page names - export all detectors from detectmatelibrary.detectors, loading the JAX-based DeepLog and LogBERT lazily - rename ECVC method_type to ecvc_detector; the old ecvc_detector_detector still loads with a DeprecationWarning
# Conflicts: # src/detectmatelibrary/common/_other_op/_variable_hooks.py
…eLibrary into update_docs_leo # Conflicts: # docs/detectors/combo.md
ipmach
approved these changes
Sep 29, 2026
viktorbeck98
approved these changes
Sep 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Task
No relevant task
Description
New structure of documentation
How Has This Been Tested?
No
Checklist
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.