Commit Graph

3 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
ae1703ad6c Update documentation for new src/ structure
Updated all documentation to reflect new directory structure:
- Source code: src/XX_name/XX_name.py (developers)
- Generated notebooks: modules/XX_name/XX_name.ipynb (students)
- Package code: tinytorch/ (auto-generated)

Files updated:
- site/tito/modules.md: Updated paths and workflow
- site/tito/troubleshooting.md: Updated file paths
- site/tito/data.md: Clarified data locations
- site/student-workflow.md: Updated workflow diagram
- site/quickstart-guide.md: Updated quickstart paths
- docs/STUDENT_QUICKSTART.md: Updated notebook paths
- docs/development/module-rules.md: Complete structure overhaul

All documentation now accurately reflects developer vs student workflows
2025-11-25 02:13:19 -05:00
Vijay Janapa Reddi
d03435c5c3 Update documentation for site/ migration and restructuring
Documentation updates across the codebase:

Root documentation:
- README.md: Updated references from book/ to site/
- CONTRIBUTING.md: Updated build and workflow instructions
- .shared-ai-rules.md: Updated AI assistant rules for new structure

GitHub configuration:
- Issue templates updated for new module locations
- Workflow references updated from book/ to site/

docs/ updates:
- STUDENT_QUICKSTART.md: New paths and structure
- module-rules.md: Updated module development guidelines
- NBGrader documentation: Updated for module restructuring
- Archive documentation: Updated references

Module documentation:
- modules/17_memoization/README.md: Updated after reordering

All documentation now correctly references:
- site/ instead of book/
- modules/XX_name/ instead of modules/source/
2025-11-10 19:42:48 -05:00
Vijay Janapa Reddi
7a9db7d52a 📚 Consolidate module documentation into single source
- Replaced 3 overlapping documentation files with 1 authoritative source
- Set modules/source/08_optimizers/optimizers_dev.py as reference implementation
- Created comprehensive module-rules.md with complete patterns and examples
- Added living-example approach: use actual working code as template
- Removed redundant files: module-structure-design.md, module-quick-reference.md, testing-design.md
- Updated cursor rules to point to consolidated documentation
- All module development now follows single source of truth
2025-07-13 19:35:16 -04:00