Commit Graph

6 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
0d2560c490 Update site documentation and development guides
- Improve site navigation and content structure
- Update development testing documentation
- Enhance site styling and visual consistency
- Update release notes and milestone templates
- Improve site rebuild script functionality
2025-11-13 10:42:51 -05:00
Vijay Janapa Reddi
29619da811 Standardize emoji usage across all site pages for professional consistency
- Removed emojis from all section headers (## and ###)
- Reduced emojis in body text and callout boxes
- Standardized link references (removed emoji prefixes)
- Maintained professional tone while keeping content accessible
- Updated quickstart-guide, student-workflow, tito-essentials, faq, datasets, community, resources, testing-framework, learning-progress, checkpoint-system, and all chapter files
2025-11-12 11:42:03 -05:00
Vijay Janapa Reddi
1a1e3d7457 Simplify and condense site documentation content 2025-11-11 22:23:21 -05:00
Vijay Janapa Reddi
94b25debbd Prepare TinyTorch for December 2024 community release
## Documentation Consistency
- Fix module count: All docs now correctly show 20 modules (01-20)
- Update Optimization Tier: Modules 14-20 (added 19 Benchmarking, 20 Competition)
- Correct tier descriptions across student-workflow, learning-progress, classroom-use

## New Documentation
- **FAQ (site/faq.md)**: Comprehensive FAQ addressing:
  - Why TinyTorch vs PyTorch/TensorFlow direct usage
  - Why TinyTorch vs micrograd/nanoGPT
  - Who should use TinyTorch
  - Course structure and flexibility
  - Practical getting started questions

- **Datasets (site/datasets.md)**: Complete dataset documentation:
  - Ship-with-repo datasets (TinyDigits 310KB, TinyTalks 40KB)
  - Downloaded datasets (MNIST 10MB, CIFAR-10 170MB)
  - Design philosophy and rationale
  - Usage instructions per milestone

- **Release Checklist (DECEMBER_2024_RELEASE.md)**:
  - Comprehensive pre-launch checklist
  - Documentation, technical, community preparation tasks
  - Version recommendation: v0.9.0
  - Success metrics and launch timeline

## Module Count Corrections
- learning-progress.md: 18→20 modules, added Benchmarking & Competition to table
- student-workflow.md: 18→20 modules, updated Optimization tier description
- classroom-use.md: 18→20 modules in feature list

## Version Recommendation
Proposed **v0.9.0** for December 2024 release:
- Signals feature-complete for individual learners
- Reserves v1.0 for classroom integration (Spring 2025)
- Allows v0.9.x patches for post-launch refinements [Claude Code](https://claude.com/claude-code)
2025-11-11 22:04:36 -05:00
Vijay Janapa Reddi
c7bc68fa37 Complete Phase 2 and 3 workflow documentation updates
Updated remaining documentation to clarify the actual TinyTorch workflow and mark optional/future features appropriately.

**Phase 2 (Important files):**
- **learning-progress.md**: Added workflow context at top, clear modules vs checkpoints vs milestones explanation, module progression tables by tier, marked checkpoints as optional
- **checkpoint-system.md**: Added prominent "Optional Progress Tracking" banner at top, clarified this is not required for core workflow

**Phase 3 (Supporting files):**
- **classroom-use.md**: Added "Coming Soon" banner for NBGrader integration, clarified current status vs planned features, updated to reflect 18 modules (not 20)

Key clarifications across all files:
- Core workflow: Edit modules → `tito module complete N` → Run milestone scripts
- Checkpoints are optional capability tracking (helpful for self-assessment)
- Instructor features marked as "coming soon" / "under development"
- All pages reference canonical student-workflow.md

Completes the workflow documentation audit identified by website-manager.
2025-11-11 21:49:37 -05:00
Vijay Janapa Reddi
a5679de141 Update documentation after module reordering
All module references updated to reflect new ordering:
- Module 15: Quantization (was 16)
- Module 16: Compression (was 17)
- Module 17: Memoization (was 15)

Updated by module-developer and website-manager agents:
- Module ABOUT files with correct numbers and prerequisites
- Cross-references and "What's Next" chains
- Website navigation (_toc.yml) and content
- Learning path progression in LEARNING_PATH.md
- Profile milestone completion message (Module 17)

Pedagogical flow now: Profile → Quantize → Prune → Cache → Accelerate
2025-11-10 19:37:41 -05:00