docs: major documentation overhaul - #521
Merged
Merged
Conversation
… reference Replace existing documentation with a comprehensive new structure: - Introduction explaining pySigma's purpose and architecture - Getting started guide with installation and quick examples - Detailed guides for converting rules, building backends, writing processing pipelines, validating rules, and using plugins - Complete API reference for all modules - TODO list for remaining documentation work - Updated Sphinx configuration with napoleon, viewcode, intersphinx - Fixed docstrings in external.py for proper RST rendering Co-authored-by: thomaspatzke <1845601+thomaspatzke@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
thomaspatzke
July 31, 2026 22:22
View session
thomaspatzke
marked this pull request as ready for review
August 3, 2026 20:39
thomaspatzke
approved these changes
Aug 3, 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
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.
The documentation was a mixed bag of incomplete class references and sparse descriptive content with many empty sections. This rewrites it from scratch with clear separation between introductory material, practical guides, and API reference.
New Structure
docs/todo.rst) — Remaining work tracked (correlation guide, filters guide, migration guide, etc.)Config & Code Changes
docs/conf.py: Addednapoleon,viewcode,intersphinxextensionssigma/processing/transformations/external.py: Reformatted 3 docstrings (FilePlaceholder, HTTPPlaceholder, CommandPlaceholder) from malformed bullet lists to NumPy-style params for clean Sphinx renderingExample
Builds with 0 Sphinx errors. All 1511 tests pass. mypy/black clean.