Refactor documentation for clarity and consistency #168
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.
Context
This pull request updates the documentation for Sigma rules, filters, and correlations to standardize code annotation syntax, improve clarity, and correct minor typos. The main change is replacing the old inline comment format (
// [!code ...]) with the new hash-based format (# [!code ...]) across all example YAML blocks. Additionally, there are improvements to filter documentation, expanded filter usage examples, and some minor corrections to field values and explanatory text.Standardization and Syntax Updates
// [!code ...]to# [!code ...]for consistency and clarity indocs/basics/conditions.md,docs/basics/log-sources.md,docs/basics/rules.md,docs/meta/correlations.md,docs/meta/filters.md, anddocs/meta/index.md. [1] [2] [3] [4] [5] [6]Documentation Improvements for Filters
Minor Corrections and Typos
Cleanup of Deprecated or Redundant Sections
Formatting and List Consistency