Skip to content

More Efficient Documentation Generation #10

@andrewrosemberg

Description

@andrewrosemberg

✍️ Summary

If every class ships a Pluto notebook and CI converts them all to HTML, the job would take hours to finish.

✅ Expected Behavior

CI should finish in ≤ 15 minutes for the full documentation set or run incrementally so unrelated notebook changes don’t prolong the build.

🎯 Impact

  • Slows contributor feedback loops (PRs blocked on CI for hours).
  • Increases risk of workflow timeouts or flaky failures.

💡 Suggested Approaches

Idea Effort Expected gain Notes
Cache notebook outputs and rebuild only changed files Medium High GitHub Actions cache + checksum
Pre-generate HTML offline & store in repo Low Medium Shifts work to author side
Split CI workflow per course directory Medium Medium Smaller, independent jobs

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions