Skip to content

Conversation

@rmitsch
Copy link
Collaborator

@rmitsch rmitsch commented Jan 1, 2026

Description

Add blog post draft.

Related Issues

Changes Made

  • Add blog post (draft)
  • Extend Python support to 3.13
  • Minor readme updates
  • Embed case study HTML in docs
  • Update docs for more consistent stylization

Checklist

  • [ ] Tests have been extended to cover changes in functionality
  • Existing and new tests succeed
  • Documentation updated (if applicable)
  • Related issues linked

Screenshots/Examples (if applicable)

@codecov
Copy link

codecov bot commented Jan 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #252   +/-   ##
=======================================
  Coverage   92.02%   92.02%           
=======================================
  Files          80       80           
  Lines        4462     4462           
=======================================
  Hits         4106     4106           
  Misses        356      356           
Files with missing lines Coverage Δ
sieves/model_wrappers/dspy_.py 84.81% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rmitsch rmitsch self-assigned this Jan 2, 2026
@rmitsch
Copy link
Collaborator Author

rmitsch commented Jan 22, 2026

@greptileai Review this PR

@greptile-apps
Copy link

greptile-apps bot commented Jan 22, 2026

Greptile Summary

This PR adds a comprehensive blog post draft, extends Python version support from 3.12 to 3.12-3.13, and enhances documentation consistency.

Key changes:

  • New blog post (docs/blog_post.md): Well-written introduction to the sieves framework explaining the problem space, solution approach, and key features with code examples
  • Python version expansion: Updated pyproject.toml to support Python 3.12-3.13 (previously restricted to 3.12 only), with corresponding updates to AGENTS.md and README.md
  • Documentation enhancements: Added crisis tweets case study page with embedded HTML visualization, added diagram assets for visual documentation
  • Stylization improvements: Capitalized site name in mkdocs.yml, refined README subtitle to emphasize "Structured" document AI, added Examples navigation section
  • Code fixes: Corrected dict merge syntax in dspy_.py to ensure track_usage defaults properly when config overrides are present
  • Test adjustments: Updated tolerance range in summarization evaluation test to be more realistic (0.4-0.9 instead of 0.2-0.8)

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • All changes are documentation-focused with minor configuration updates. The Python version expansion is well-documented and the code fix in dspy_.py corrects a subtle bug. The test adjustment reflects more realistic evaluation thresholds. No breaking changes or risky logic modifications.
  • No files require special attention

Important Files Changed

Filename Overview
docs/blog_post.md New comprehensive blog post introducing sieves framework with examples and use cases
pyproject.toml Extended Python support from 3.12 only to 3.12-3.13, added 3.13 classifier
README.md Updated badge to show Python versions, refined subtitle to emphasize structured document AI
AGENTS.md Updated Python version requirements and generalized agent guidance from Claude Code to LLM agents
mkdocs.yml Capitalized site name, added HTML formatting to repo name, added Examples section linking crisis tweets
sieves/model_wrappers/dspy_.py Fixed dict merge syntax to ensure track_usage defaults correctly when overridden in config
sieves/tests/tasks/predictive/test_summarization.py Adjusted test tolerance range from 0.2-0.8 to 0.4-0.9 for evaluation metric
docs/examples/crisis_tweets.md New example page embedding crisis tweets HTML case study via iframe

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation
    participant Blog as Blog Post
    participant Config as Configuration
    participant Code as Code Base
    
    Dev->>Config: Update pyproject.toml
    Note over Config: Extend Python support<br/>3.12 only → 3.12-3.13
    
    Dev->>Docs: Update AGENTS.md
    Note over Docs: Generalize from Claude Code<br/>to LLM agents
    
    Dev->>Docs: Update README.md
    Note over Docs: Refine subtitle and<br/>Python version badge
    
    Dev->>Blog: Create blog_post.md
    Note over Blog: Comprehensive introduction<br/>with use cases and examples
    
    Dev->>Docs: Add crisis_tweets.md
    Dev->>Docs: Add crisis_tweets_raw.html
    Note over Docs: Embed case study HTML<br/>via iframe
    
    Dev->>Docs: Add diagram assets
    Note over Docs: 5 Mermaid diagram files<br/>(SVG and PNG)
    
    Dev->>Config: Update mkdocs.yml
    Note over Config: Add Examples section,<br/>stylize site name
    
    Dev->>Code: Fix dspy_.py
    Note over Code: Correct dict merge syntax<br/>for track_usage
    
    Dev->>Code: Adjust test_summarization.py
    Note over Code: Update metric tolerance<br/>0.2-0.8 → 0.4-0.9
    
    Dev->>Config: Update uv.lock
    Note over Config: Regenerate lock file<br/>with new dependencies
Loading

@greptile-apps
Copy link

greptile-apps bot commented Jan 22, 2026

Greptile found no issues!

From now on, if a review finishes and we haven't found any issues, we will not post anything, but you can confirm that we reviewed your changes in the status check section.

This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR".

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.

Review dependency and Python version restrictions

2 participants