Skip to content

Docs/minor fixes - #352

Merged
thorinaboenke merged 40 commits into
developmentfrom
docs/minor_fixes
Oct 12, 2026
Merged

thorinaboenke merged 40 commits into
developmentfrom
docs/minor_fixes

Conversation

@thorinaboenke

@thorinaboenke thorinaboenke commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor
  • Fixed typos, grammar and copy-paste mistakes across the docs
  • Replaced all -- pseudo-dashes in the docs
  • Enabled navigation.footer and removed the "Go back Index" links
  • Removed the orphaned docs/examples/others/basic_usage.py
  • Installation: added requirements and git clone
  • Basic knowledge: fixed the logging example and the parsed-log table, added the EventID concept
  • Quickstart: fixed paths, added "Before you start", output files are overwritten instead of appended
  • Tutorial: own data files in docs/examples/data/, path note simplified, stale claims corrected
  • Schemas: corrected field types, documented raised exceptions, renamed "Tutorial" to "Examples"
  • Parsers: documented what run() fills in, the parse() input and the parse() return values
  • Detectors: fixed the API snippet and config example, documented named EventIDs and the auto_config default
  • Alert aggregation: fixed class names and the API, documented the window behavior and run()
  • Federation: fixed the Bigram Frequency claim, the example typos and the "Stack later" heading
  • Contribution and development guides: fixed headings, the git checkout command and the doc-test command
  • Corrected the Value Range, Combo, JSON and LogBatcher page descriptions
  • Code: exported IncorrectSchema and NotSupportedSchema from detectmatelibrary.schemas, and fixed the return annotations

(feedback on bigger structural issues will follow separately)


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

@viktorbeck98 viktorbeck98 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

A nice improvement of the documentation!

@thorinaboenke
thorinaboenke merged commit 31beac9 into development Oct 12, 2026
4 checks passed
@thorinaboenke
thorinaboenke deleted the docs/minor_fixes branch October 12, 2026 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants