Skip to content

Conversation

@mmcky
Copy link
Contributor

@mmcky mmcky commented Oct 20, 2025

Summary

This PR improves the README with clearer documentation for:

1. GitHub Pages Deployment

  • Added comprehensive deployment section explaining automatic deployment on push to main
  • Documented manual deployment process via GitHub Actions
  • Included custom domain setup for interactive.quantecon.org
  • DNS configuration and CNAME file management

2. Content Management Workflow

  • Clarified that contributors should edit files directly in this repository
  • Explained the purpose of update_lectures.py (maintainer tool for syncing from upstream)
  • Removed confusing cross-repository requirements
  • Standard PR workflow: fork → branch → edit → test → PR

3. Contributing Guidelines

  • Simplified to standard GitHub workflow
  • Clear step-by-step instructions
  • Automatic deployment after PR merge

4. Better Structure

  • Reorganized sections for better flow
  • Added Quick Start guide
  • Added Troubleshooting section
  • Technology stack overview
  • Project structure diagram

Changes

  • Enhanced deployment documentation
  • Clarified content management process
  • Improved contributing section
  • Better overall organization and readability

Testing

  • Verified all links work
  • Confirmed instructions are clear and actionable

- Add clear GitHub Pages deployment section with custom domain setup
- Explain interactive.quantecon.org configuration
- Clarify content management workflow (direct edits vs sync script)
- Remove confusing cross-repository requirements
- Add standard PR workflow for contributors
- Improve structure and readability
- Add troubleshooting section
@mmcky mmcky self-assigned this Oct 20, 2025
@netlify
Copy link

netlify bot commented Oct 20, 2025

Deploy Preview for beautiful-dodol-cb9543 ready!

Name Link
🔨 Latest commit 411f0af
🔍 Latest deploy log https://app.netlify.com/projects/beautiful-dodol-cb9543/deploys/68f57f9fce3338000822e2e1
😎 Deploy Preview https://deploy-preview-32--beautiful-dodol-cb9543.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@mmcky
Copy link
Contributor Author

mmcky commented Oct 20, 2025

@kp992 should all updates happen via update_lectures.py? Does this make the necessary adjustments when syncing?

@kp992
Copy link
Collaborator

kp992 commented Oct 20, 2025

Thanks for opening this PR @mmcky. Hmm, almost all the major updates are handle in update_lectures.py but there are a few manual edits that I made this according to mystmd, so probably I can work on figuring out how to consolidate and write workflow for automatic updates.

@mmcky
Copy link
Contributor Author

mmcky commented Oct 22, 2025

Thanks for opening this PR @mmcky. Hmm, almost all the major updates are handle in update_lectures.py but there are a few manual edits that I made this according to mystmd, so probably I can work on figuring out how to consolidate and write workflow for automatic updates.

Thanks @kp992 I am not sure this is worth the time to make this 100% -- just wanted to check the docs.

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.

2 participants