docs: add comprehensive SUMMARY.md with structure map, dependencies, and reproducibility tools #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tructure & reproducibility Add a comprehensive SUMMARY.md, mapping structure & key topics of major notebook series. Introduce scripts/list_notebooks.py and Makefile (toc) for auto-generating markdown TOC. Document core dependencies and environment guidelines, validated via partial smoke runs. .gitignore updated for virtualenv, Jupyter cache, and data folders. Suggestions for repo maintenance added. This change improves discoverability for learners and maintainers, standardizes entry points, and provides guidance for dependency management and reproducibility in a diverse notebook repo.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a comprehensive structure map, summary, dependency guidance, and automation tooling to enhance navigation, usage, and maintainability for the multi-notebook AI/ML repo.
Details
make toc) for auto-generating and maintaining the notebook table of contentsWarning: Task VM test is not passing, cto.new will perform much better if you fix the setup