Education
proofread avatar

proofread

Automated, non-destructive proofreading for LaTeX and Quarto lecture files, generating quality reports for grammar, typos, and academic style.

Introduction

The proofread skill is an essential quality assurance tool designed for academic content creators and instructors using LaTeX or Quarto for lecture development. It performs a comprehensive, read-only analysis of your source documents, ensuring high-quality output without modifying the underlying source code. By acting as a non-destructive audit layer, it allows authors to identify issues early—before the lecture release—maintaining pedagogical standards and professional clarity. This agent is perfectly suited for researchers, PhD students, and educators who manage large volumes of technical slides and academic documentation within version-controlled repositories.

  • Performs automated grammar and typo detection, covering subject-verb agreement, articles, prepositions, and tense consistency.

  • Monitors technical layout concerns, including overfull hboxes in LaTeX and content boundary overflows in Quarto.

  • Ensures terminology consistency and adheres to academic writing standards by identifying informal language or awkward constructions.

  • Generates structured Markdown reports saved to the quality_reports/ directory for easy review.

  • Provides a detailed breakdown of findings, including line numbers, current text, proposed corrections, and categorical severity.

  • Trigger this skill using natural language commands such as "proofread", "check for typos", or "any writing errors?".

  • Accepts specific filenames for targeted review or "all" for a comprehensive check across Slides/ and Quarto/ directories.

  • Always performs a read-only pass; the agent does not edit source files, ensuring that all fixes remain under human control.

  • Designed for the Claude Code academic workflow, integrating seamlessly with existing LaTeX preambles and SCSS themes.

  • For optimal usage, run this after completing content drafts but before final compilation or deployment of lecture materials.

Repository Stats

Stars
1,028
Forks
2,110
Open Issues
9
Language
HTML
Default Branch
main
Sync Status
Idle
Last Synced
May 3, 2026, 06:01 AM
View on GitHub