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/
This commit is contained in:
Vijay Janapa Reddi
2025-11-10 19:42:48 -05:00
parent 0af88840b1
commit a4e38cb906
20 changed files with 613 additions and 76 deletions

View File

@@ -3,7 +3,7 @@
**Version**: 2.0
**Date**: January 2025
**Status**: Complete Reference Guide
**Reference Implementation**: `modules/source/08_optimizers/optimizers_dev.py`
**Reference Implementation**: `modules/08_optimizers/optimizers_dev.py`
This document defines the complete set of rules, patterns, and conventions for developing TinyTorch modules. Instead of maintaining separate documentation, **use `08_optimizers` as your reference implementation** - it follows all current patterns perfectly.
@@ -26,7 +26,7 @@ Each module follows this pedagogical pattern:
### 1. **File Naming Convention**
```
modules/source/NN_modulename/
modules/NN_modulename/
├── modulename_dev.py # Main development file (Python source)
├── modulename_dev.ipynb # Generated notebook (temporary)
├── module.yaml # Module configuration
@@ -94,7 +94,7 @@ print("Ready to [action]!")
"""
## 📦 Where This Code Lives in the Final Package
**Learning Side:** You work in `modules/source/NN_modulename/modulename_dev.py`
**Learning Side:** You work in `modules/NN_modulename/modulename_dev.py`
**Building Side:** Code exports to `tinytorch.core.modulename`
```python
@@ -433,7 +433,7 @@ Before completing a module:
## 📚 Additional Resources
- **Reference Implementation**: `modules/source/08_optimizers/optimizers_dev.py`
- **Reference Implementation**: `modules/08_optimizers/optimizers_dev.py`
- **NBGrader Documentation**: [NBGrader docs](https://nbgrader.readthedocs.io/)
- **NBDev Documentation**: [NBDev docs](https://nbdev.fast.ai/)
- **TinyTorch CLI**: Use `tito --help` for development commands