Review Jupyter Book
Review the Jupyter Book located at $ARGUMENTS (default: docs/book if no argument provided).
Steps
- •
Read the table of contents: Read
_toc.ymlin the book directory to understand the structure - •
Parse the structure: Extract all file references from the TOC, noting:
- •Parts/chapters organization
- •File paths (relative to book directory)
- •Any notebooks (.ipynb files)
- •
Read all files systematically: Read each file in order, including:
- •The root file specified in
root: - •All chapter files in each part
- •Note: For .ipynb files, read them as notebooks
- •The root file specified in
- •
Analyze and report: Provide a structured report with:
Structure Summary
- •Overview of parts and chapters
- •Total file count
Quality Assessment
For each major section:
- •Content completeness
- •Code example quality (Python/C++ parity)
- •Link validity (demo links, API references)
Issues Found
- •Typos and grammatical errors
- •Broken or inconsistent links
- •Formatting problems
- •Missing content
- •Outdated information
Suggestions
- •Improvements for clarity
- •Missing documentation
- •Structural improvements
Notes
- •Read files in parallel where possible to reduce time
- •For large books, summarize rather than quote extensively
- •Flag any files that fail to read
- •Check for consistency in formatting patterns across similar pages