Skip to content

docs: complete documentation overhaul#490

Open
frack113 wants to merge 2 commits into
mainfrom
docs-cleanup
Open

docs: complete documentation overhaul#490
frack113 wants to merge 2 commits into
mainfrom
docs-cleanup

Conversation

@frack113

@frack113 frack113 commented Jul 3, 2026

Copy link
Copy Markdown
Member

Documentation Overhaul

This PR completes the documentation structure.

Changes

  • Add comprehensive documentation structure with Sphinx and Furo theme
  • Include Phase 1-5 documentation files (Quickstart, Cheat Sheet, Tutorials, Backend/Transformation Dev guides)
  • Fix docstring formatting issues that prevented HTML build
  • Configure ReadTheDocs and GitHub Actions for documentation deployment
  • Add custom sidebar navigation with Index and Module Index links
  • Update pyproject.toml and poetry.lock with Sphinx dependencies

Files Modified

  • 21 files changed, 1943 insertions(+), 39 deletions(-)
  • New docs: Backend_Development, Conditions_Guide, Quickstart, Transformation_Cheat_Sheet, Transformation_Development, YAML_Pipeline_Tutorial, Changelog
  • Config: .readthedocs.yaml, .github/workflows/docs.yml, docs/conf.py, docs/index.rst
  • Fixes: sigma/collection.py, sigma/conversion/base.py (docstring formatting)
  • Deps: pyproject.toml, poetry.lock (Sphinx dependencies)

Build Verification

  • Documentation builds successfully with (0 warnings)
  • GitHub Actions workflow configured for automated documentation deployment
image image

- Add comprehensive documentation structure with Sphinx and Furo theme
- Include Phase 1-5 documentation files (Quickstart, Cheat Sheet, Tutorials, etc.)
- Fix docstring formatting issues that prevented HTML build
- Configure ReadTheDocs and GitHub Actions for documentation deployment
- Add custom sidebar navigation with Index and Module Index links
- Update pyproject.toml and poetry.lock with Sphinx dependencies
@frack113 frack113 changed the title docs: complete documentation overhaul with Phase 1-5 content docs: complete documentation overhaul Jul 3, 2026
@frack113 frack113 requested a review from thomaspatzke July 7, 2026 06:54
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.

1 participant