Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 12, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed guidance for working effectively in this Jupyter Book repository.

What's Added

The instructions cover the complete development workflow for this QuantEcon Python Programming lecture series repository:

Environment Setup & Build Process:

  • Step-by-step conda environment creation (conda env create -f environment.yml)
  • All validated build commands with measured timing expectations
  • LaTeX dependency installation for PDF generation
  • HTML, PDF, and Jupyter notebook build processes

Critical Timing & Timeout Guidance:

  • Environment creation: 3 minutes (recommended timeout: 5+ minutes)
  • HTML builds: 4+ minutes (recommended timeout: 8+ minutes)
  • LaTeX dependencies: 20+ minutes (recommended timeout: 35+ minutes)
  • Explicit "NEVER CANCEL" warnings for long-running operations

Manual Validation Requirements:

  • HTTP server setup for testing built website functionality
  • Navigation testing through lecture links
  • Content rendering verification
  • Output file validation procedures

Repository Structure & Troubleshooting:

  • Complete overview of key directories (/lectures/, /_build/, etc.)
  • Common issue explanations (expected warnings, network limitations)
  • Build failure recovery procedures
  • Performance optimization guidance

Validation

All commands and procedures have been thoroughly tested:

  • ✅ Complete environment setup and activation
  • ✅ Full HTML build process (4 minutes 20 seconds measured)
  • ✅ PDF LaTeX generation with compiled output
  • ✅ Jupyter notebook conversion (41 seconds measured)
  • ✅ Website functionality verified via HTTP server
  • ✅ Navigation and content rendering validated

The built website displays the complete lecture series with proper navigation and styling:

Jupyter Book Website

The instructions follow the specified imperative tone ("Run this command", "Do not do that") and prioritize providing exact, working commands over verbose explanations. This enables GitHub Copilot to work efficiently in the codebase without trial-and-error or time-consuming searches.

Fixes #381.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https (dns block)
  • fred.stlouisfed.org
    • Triggering command: /usr/share/miniconda/envs/quantecon/bin/python -Xfrozen_modules=off -m ipykernel_launcher -f /tmp/tmpatezbecg.json --HistoryManager.hist_file=:memory: (dns block)
    • Triggering command: /usr/share/miniconda/envs/quantecon/bin/python -Xfrozen_modules=off -m ipykernel_launcher -f /tmp/tmp20jfo41y.json --HistoryManager.hist_file=:memory: (dns block)
    • Triggering command: /usr/share/miniconda/envs/quantecon/bin/python -Xfrozen_modules=off -m ipykernel_launcher -f /tmp/tmp87yz_uwo.json --HistoryManager.hist_file=:memory: (dns block)
  • jax.quantecon.org
    • Triggering command: /usr/share/miniconda/envs/quantecon/bin/python /usr/share/miniconda/envs/quantecon/bin/jb build lectures --path-output ./ -n -W --keep-going (dns block)
    • Triggering command: /usr/share/miniconda/envs/quantecon/bin/python /usr/share/miniconda/envs/quantecon/bin/jb build lectures --builder pdflatex --path-output ./ -n -W --keep-going (dns block)
    • Triggering command: /usr/share/miniconda/envs/quantecon/bin/python /usr/share/miniconda/envs/quantecon/bin/jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter -n -W --keep-going (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link

github-actions bot commented Aug 12, 2025

@github-actions github-actions bot temporarily deployed to pull request August 12, 2025 00:53 Inactive
Copilot AI and others added 2 commits August 12, 2025 01:06
…pment

Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for Jupyter Book development workflow Aug 12, 2025
@Copilot Copilot AI requested a review from mmcky August 12, 2025 01:08
Copilot finished work on behalf of mmcky August 12, 2025 01:08
@mmcky mmcky marked this pull request as ready for review August 12, 2025 01:10
@github-actions github-actions bot temporarily deployed to pull request August 12, 2025 01:16 Inactive
@mmcky mmcky merged commit aef6fd5 into main Aug 12, 2025
5 checks passed
@mmcky mmcky deleted the copilot/fix-381 branch August 12, 2025 01:18
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.

✨Set up Copilot instructions
2 participants