A GitHub Action and local CLI for automated style guide compliance checking of QuantEcon lecture materials using AI-powered analysis.
Uses Claude Sonnet 4.5 with extended thinking to check 49 style rules across 8 categories (writing, math, code, JAX, figures, references, links, admonitions) with zero false positives.
Comment on any issue in your lecture repository:
@qe-style-checker lecture_name
@qe-style-checker lecture_name writing,math
pip install git+https://github.com/QuantEcon/action-style-guide.git
export ANTHROPIC_API_KEY='your-key-here'
qestyle lecture.md # Review all categories, apply fixes
qestyle lecture.md --categories writing # Specific category
qestyle lecture.md --dry-run # Report only, no changesFull documentation is available at the docs site.
- Getting Started — Setup, installation, workflow configuration
- Configuration — Action inputs, LLM model, rule types
- Rules Reference — All 49 rules by category and type
- CLI Guide — Local
qestylecommand usage - GitHub App Setup — Production setup with GitHub Apps
- Architecture — System design, components, data flow
- Contributing — Dev setup, code style, PR process
- Testing — Unit tests, integration tests, production testing
- Extended Thinking — Experiment results and prompt design
- Roadmap — Development plan and future enhancements
MIT License — see LICENSE for details.