Commit Graph

97 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
df0ece034e Fix demo visibility: Show setup commands, only hide fast-forwards
Key changes:
- SHOW cd and source activate.sh in all demos (users see full setup)
- ONLY use Hide for Demo 03's module 01-06 completions (fast-forward)
- Remove unnecessary clear command
- Add module reset to demo script for clean slate

This ensures users see the real workflow while keeping demos concise.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:50:53 -05:00
Vijay Janapa Reddi
b461340e34 Fix first frame issue: Show activation output instead of empty prompt
Moved Show command to appear after source activate.sh completes,
so the first visible frame shows the activation finishing instead
of an empty prompt. This makes the recording flow more natural.

Changes:
- cd command stays hidden
- source activate.sh runs inside Hide block
- Show appears after activation completes
- First frame now shows activation output

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:43:04 -05:00
Vijay Janapa Reddi
58fe9363f0 Simplify CLI welcome screen and remove redundant community commands
Dramatically simplified the welcome screen to show only essential info:
- Quick Start (3 commands)
- Track Progress (2 commands)
- Community (1 command)

Removed redundant commands:
- leaderboard -> merged into community
- olympics -> merged into community

These backend-dependent features are consolidated into a single
community command that will handle all social features when the
backend is ready.

Changes:
- Simplified welcome screen (10 lines vs 40+ lines)
- Moved leaderboard.py and olympics.py to _archived/
- Updated all tests (45 passing)
- Cleaner --help output
- Updated archived README

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:41:51 -05:00
Vijay Janapa Reddi
456041a1cb Regenerate all demos with TinyTorch custom theme
All 4 demos now use the custom TinyTorch color palette:
- Demo 00 (Welcome): 440K - Shows TinyTorch branding
- Demo 02 (Build, Test, Ship): 3.3M - Module workflow
- Demo 03 (Milestone Unlocked): 1.7M - Milestone achievement
- Demo 04 (Share Journey): 1.1M - Community engagement

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:35:21 -05:00
Vijay Janapa Reddi
551fc514a7 Add custom TinyTorch theme to all demos
Replaced Catppuccin Mocha with custom TinyTorch theme matching
our brand colors:
- Dark background (#1E1E2E) for modern look
- Pastel colors (pink, green, yellow, blue, magenta, cyan)
- Consistent with TinyTorch's fire/torch aesthetic

All demos now have unified, branded color scheme!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:29:03 -05:00
Vijay Janapa Reddi
d9bb2496b7 Add styling to Demo 00: margin, border radius, loop offset
Added the same professional styling to Demo 00 (Welcome) that
the other demos have:
- Margin 20px
- MarginFill #1E1E2E
- BorderRadius 10px
- LoopOffset 10%

Now all demos have consistent polished styling!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:27:54 -05:00
Vijay Janapa Reddi
2e412bc8b6 Fix all demo tapes: WindowBar at top, proper module completions
- Moved Set WindowBar Colorful to top of all tapes (required by VHS)
- Demo 03: Changed to properly complete modules 01-06 (not just export)
  - Uses Hide/Show pattern to complete modules 01-06 in background
  - Then shows module status to prove modules are completed
  - This ensures milestone 03 prerequisites are met

All tapes now follow VHS best practices!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 11:22:24 -05:00
Vijay Janapa Reddi
5db3aa1457 Regenerate demos with all improvements: better examples, styling, and polish
All demos now feature:
- Margin (20px) + MarginFill (#1E1E2E) for depth
- BorderRadius (10px) for modern polished look
- LoopOffset (10%) for better GIF preview

Demo 02 (Build, Test, Ship) - 3.4M:
- Better Tensor example shows sigmoid curve: [-2.0, -1.0, 0.0, 1.0, 2.0]
- Changed message: "You didn't just import it. You BUILT it!"

Demo 03 (Milestone Unlocked) - 1.7M:
- Shows module status for context
- Fixed: tito milestones (not milestone)
- Hidden setup exports modules 01-06 before showing 07

Demo 04 (Share Journey) - 1.5M:
- Correct prompts: GitHub username, Country, Institution
- Removed incorrect "intermediate" prompt

All commands tested and verified working!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 10:54:32 -05:00
Vijay Janapa Reddi
2995b34d96 Improve all demo tapes: better examples, correct commands, polished styling
Demo 02 (Build, Test, Ship):
- Changed to "You didn't just import it. You BUILT it!"
- Better Tensor example: sig(Tensor([-2.0, -1.0, 0.0, 1.0, 2.0]))

Demo 03 (Milestone Unlocked):
- Added module status to show context
- Fixed command: tito milestones (not milestone)
- Hidden setup: export modules 01-06 before showing module 07

Demo 04 (Share Journey):
- Fixed community prompts: GitHub username, Country, Institution
- Removed incorrect "intermediate" prompt

All demos:
- Added Margin (20px) + MarginFill (#1E1E2E) for depth
- Added BorderRadius (10px) for polished look
- Added LoopOffset (10%) for better GIF preview frame

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-28 21:47:20 -05:00
Vijay Janapa Reddi
86d640f66b Regenerate demos 02, 03, 04 with verified working commands
All demos have been regenerated with:
- Fixed cd to TinyTorch directory
- Working module complete command (after fixing import bug)
- Verified Python imports work correctly
- Consistent @profvjreddi 🔥 › prompt

All commands tested and verified before recording.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-28 21:17:06 -05:00
Vijay Janapa Reddi
ad0a0d503d Regenerate Demo 00 with working cd command
Fixed Demo 00 to properly cd into TinyTorch directory before
activating environment. The demo now works correctly and shows
the full tito welcome screen at 1280x1000 dimensions.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-28 21:04:52 -05:00
Vijay Janapa Reddi
bb5e631214 Remove checkpoint command (superseded by milestones)
The checkpoint command tracked 21 technical capability checkpoints, but
this overlapped significantly with the milestones system which provides
a more engaging, narrative-driven progress tracking experience.

Changes:
- Removed checkpoint command and test files
- Updated milestone.py to remove checkpoint dependencies
- Removed checkpoint integration from export.py, src.py, leaderboard.py
- Updated CLI help text to reference milestones instead
- Updated test suite (49/49 tests passing)
- Archived checkpoint.py for reference

Rationale:
- Milestones is more engaging (historical ML achievements)
- Module status already shows granular progress
- Reduces duplication and confusion
- Single clear progress tracking system

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 01:24:25 +01:00
Vijay Janapa Reddi
f6c0e21b42 Fix all demo tapes: Add cd to TinyTorch directory
All VHS tapes now include a hidden `cd /Users/VJ/GitHub/TinyTorch`
command before activating the environment. This ensures the demos
work regardless of where VHS is run from.

Updated demos:
- 00-welcome: Fixed and regenerated (259K)
- 02-build-test-ship: Added cd command
- 03-milestone-unlocked: Added cd command
- 04-share-journey: Added cd command

All tapes now work reliably!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:43:01 +01:00
Vijay Janapa Reddi
7ee171dfd2 Update Demo 00: Use taller dimensions to show full tito output
Changed height from 720 to 1000 pixels so the entire tito welcome
screen is visible without scrolling. The full command reference is
now readable in the GIF.

Bonus: File size reduced from 170K to 51K due to better aspect ratio.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:37:21 +01:00
Vijay Janapa Reddi
a3c9f5dc52 Organize demo files: move GIFs to gifs/ subdirectory
Improved demo file organization:
- Created docs/_static/demos/gifs/ for all GIF outputs
- Updated all tape files to output to gifs/ folder
- Moved all existing GIFs to new location

Directory structure:
docs/_static/demos/
├── gifs/           (all GIF outputs)
├── tapes/          (all VHS tape scripts)
├── scripts/        (helper scripts)
├── README.md
└── WORKFLOW.md

This makes the demos directory much cleaner and easier to navigate.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:29:48 +01:00
Vijay Janapa Reddi
677f1fd263 Update Demo 00: Hide activation step for cleaner presentation
Changed welcome demo to use Hide/Show to skip the environment
activation step. Now the GIF starts directly with 'tito' appearing,
making it cleaner and more focused on the beautiful logo and
command reference.

Perfect first impression - just the branding!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:23:11 +01:00
Vijay Janapa Reddi
bee62ee52a Add Demo 00: Welcome screen showcasing TinyTorch branding
Created a simple, impactful demo that shows:
- The beautiful ASCII TORCH logo
- The "Don't just import it. Build it." tagline
- Complete command reference organized by category
- Quick start guide

Perfect for:
- Social media posts
- README hero image
- First impression for new students

Demo 00 (Welcome): 1.5M

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:21:09 +01:00
Vijay Janapa Reddi
a43a834987 Regenerate all demo GIFs with consistent @profvjreddi prompt
Updated all demo tapes (02, 03, 04) to:
- Use consistent prompt: "@profvjreddi 🔥 › "
- Add "source activate.sh" at beginning to ensure tito is available
- This makes demos work when starting from a fresh terminal

Regenerated GIFs:
- Demo 02 (Build, Test, Ship): 3.2M (was 699K - now includes activation)
- Demo 03 (Milestone Unlocked): 273K (was 143K - now includes activation)
- Demo 04 (Share Journey): TBD

All demos now show the proper branded prompt throughout.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:16:34 +01:00
Vijay Janapa Reddi
204ac81b42 Make CLI welcome screen dynamically generated from registered commands
- Remove hardcoded command list in welcome screen
- Dynamically build help from self.commands registry
- Categorize commands: Essential, Student Workflow, Community, Developer, Shortcuts
- Ensures welcome screen always shows only registered commands
- No more stale command references

Benefits:
- Single source of truth (commands registry)
- Adding/removing commands automatically updates welcome
- Clear categorization for different user roles

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:14:49 +01:00
Vijay Janapa Reddi
f36abec2e7 Fix module completion tracking and add sequential validation
- Remove module from started_modules when marking complete
- Add validation to prevent completing modules out of order
- Show all modules in status (removed smart collapsing)
- Fix data integrity: modules must be completed sequentially

Prevents invalid states where module N is complete but N-1 is not.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:08:52 +01:00
Vijay Janapa Reddi
02553314d3 Fix demo tapes 03 and 04: use Sleep instead of Wait for reliability
Changed VHS Wait syntax to simple Sleep commands for more reliable demo recording.
The Wait+Line syntax was unreliable with the fire emoji prompt pattern.

Generated GIFs:
- Demo 02 (Build, Test, Ship): 699K
- Demo 03 (Milestone Unlocked): 143K
- Demo 04 (Share Journey): 124K

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-29 00:01:31 +01:00
Vijay Janapa Reddi
54c357f566 Update demo scripts and add README for demo workflow 2025-11-28 22:35:20 +01:00
Vijay Janapa Reddi
d3a38a75c0 Remove --skip-checks from milestone demo tape 2025-11-28 22:32:32 +01:00
Vijay Janapa Reddi
d72a637dd1 Add website static assets (CSS, JS, logos, demos) 2025-11-28 22:06:02 +01:00
Vijay Janapa Reddi
d7bdbe67d4 Remove docs/_build from repository 2025-11-28 14:59:59 +01:00
Vijay Janapa Reddi
403d4c2f4c Add .tito/backups and docs/_build to gitignore 2025-11-28 14:59:51 +01:00
Vijay Janapa Reddi
09d1d00f06 Remove stale documentation files
Removed orphaned/duplicate files not referenced in table of contents:
- INSTRUCTOR_GUIDE.md (duplicate of instructor-guide.md)
- STUDENT_QUICKSTART.md (duplicate of quickstart-guide.md)
- TEAM_ONBOARDING.md (moved to usage-paths/)
- checkpoint-system.md (not in TOC, minimal refs)
- learning-progress.md (not in TOC, minimal refs)
- learning-journey-visual.md (not in TOC, self-ref only)
- cifar10-training-guide.md (no references)
- cover.md (not in TOC)
- PRIVACY_DATA_RETENTION.md (internal doc)
- INSTRUCTOR.md (root level, moved to docs/)
- Various old scripts (activate-tinytorch, cleanup scripts, etc.)

Website rebuilt successfully with 46 warnings (same as before).
All critical content preserved (student-workflow, quickstart-guide, etc.)
2025-11-28 05:05:44 +01:00
Vijay Janapa Reddi
c058ab9419 Fix documentation links after site → docs reorganization
- Replace all .html → .md in markdown source files (43 instances)
- Fix broken links: tito-essentials.md → tito/overview.md
- Remove broken links to non-existent leaderboard/olympics-rules pages
- Fix PDF_BUILD_GUIDE reference in website-README.md

Website rebuilt successfully with 46 warnings.

Changes:
- All markdown files now use .md extension for internal links
- Removed references to missing/planned files
- Website builds cleanly and all links are functional
2025-11-28 05:01:44 +01:00
Vijay Janapa Reddi
8f99175f2c Fix CLI bugs and rename milestone → milestones
## Bug Fixes
- Fixed Bug #1: Reset command directory path (modules/ → src/)
- Fixed Bug #2: Reset command file naming (short name → full module name)
- Fixed Transformer milestone prerequisites (skip CNN/spatial modules)

## Command Changes
- Renamed `milestone` → `milestones` (plural)
- Removed old `milestone` backward compatibility alias
- Updated all milestone references to use "MLPerf benchmarks"

## Testing
- Completed 8/8 Priority 1 & 2 CLI tests
- Documented 3 bugs (1 fixed, 2 open)
- Added comprehensive test documentation

## Visual Improvements
- Fixed "Tiny" capitalization in banner
- Enhanced prerequisite checking with locked module display
- Improved completion workflow with 3-step visual feedback

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-25 13:07:30 -05:00
Vijay Janapa Reddi
785e7c1582 Enhance CLI visual design for better student engagement
Improved three key student-facing commands with Rich formatting:

1. tito module status
   - Visual progress bar (███░░░)
   - Clean table with status icons (🚀🔒)
   - Smart list collapsing for readability
   - Milestone readiness indicators
   - Clear "Next Action" guidance

2. tito module complete
   - 3-step visual workflow (Test → Export → Track)
   - Celebratory completion message
   - Shows what students can now do
   - Progress percentage tracking
   - Suggests next module

3. tito module start
   - Prerequisite checking (enforces sequential learning)
   - Beautiful locked/unlocked module displays
   - Shows missing prerequisites in table
   - Milestone progress preview
   - Clear step-by-step instructions

Design principles:
- Progressive disclosure (show relevant info only)
- Clear visual hierarchy (panels, tables, separators)
- Pedagogical guidance (always show next action)
- Consistent iconography (🚀🔒🏆💡)

Ready for demo GIF recording!

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-25 11:53:29 -05:00
Vijay Janapa Reddi
3e36b520b3 Complete src-modules separation: Update all symlinks and infrastructure
## Symlink Updates (modules/ → src/)
- Update all 20 site/modules/*_ABOUT.md symlinks to point to src/
- Update all 20 src/*/ABOUT.md internal references

## Infrastructure Changes
- Remove bin/ directory scripts (moved to scripts/ in previous commit)
- Update .envrc: Reference new scripts/ directory structure
- Update pyproject.toml: Reflect src/ as primary source location
- Update docs/development/MODULE_ABOUT_TEMPLATE.md: src/ paths
- Update site/requirements.txt: Documentation dependencies

## Restructuring Complete

The repository now has clean separation:
- `src/`: Developer source code (graded notebooks with solutions)
- `modules/`: Student workspace (generated from src/)
- `scripts/`: Build and utility scripts
- `site/`: Documentation and Jupyter Book website

This enables the intended workflow:
1. Developers work in src/
2. Students receive generated notebooks in modules/
3. Both can coexist without conflicts

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-25 11:30:06 -05:00
Vijay Janapa Reddi
7826e167b6 Reorganize repository structure and add build tooling
## Repository Organization
- Move scripts from bin/ to scripts/ directory
  - activate-tinytorch: Environment activation script
  - generate_module_metadata.py: Module metadata generator
  - generate_student_notebooks.py: Student notebook generator
  - tito: TinyTorch CLI tool

## Build System
- Add site/build.sh: Jupyter Book 1.x build automation script
  - Auto-detects project root or site directory
  - Activates virtual environment if available
  - Handles clean builds with proper error handling

## Documentation
- Add docs/history/ for migration documentation
  - ROLLBACK_TO_JB1.md: Jupyter Book 1.x rollback documentation
  - MIGRATION_TO_V2.md: Jupyter Book 2.0 migration attempt notes

## Infrastructure Updates
- Update all site/modules/*_ABOUT.md symlinks: modules/ → src/
- Update all src/*/ABOUT.md symlinks: modules/ → src/
- Update .envrc: Reflect new scripts/ directory structure
- Update pyproject.toml: Add build system dependencies

This commit completes the src-modules separation restructuring and
adds necessary tooling for the new repository layout.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-25 11:29:41 -05:00
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
d3a126235c Restructure: Separate developer source (src/) from learner notebooks (modules/)
Major directory restructure to support both developer and learner workflows:

Structure Changes:
- NEW: src/ directory for Python source files (version controlled)
  - Files renamed: tensor.py → 01_tensor.py (matches directory naming)
  - All 20 modules moved from modules/ to src/
- CHANGED: modules/ now holds generated notebooks (gitignored)
  - Generated from src/*.py using jupytext
  - Learners work in notebooks, developers work in Python source
- UNCHANGED: tinytorch/ package (still auto-generated from notebooks)

Workflow: src/*.py → modules/*.ipynb → tinytorch/*.py

Command Updates:
- Updated export command to read from src/ and generate to modules/
- Export flow: discovers modules in src/, converts to notebooks in modules/, exports to tinytorch/
- All 20 modules tested and working

Configuration:
- Updated .gitignore to ignore modules/ directory
- Updated README.md with new three-layer architecture explanation
- Updated export.py source mappings and paths

Benefits:
- Clean separation: developers edit Python, learners use notebooks
- Better version control: only Python source committed, notebooks generated
- Flexible learning: can work in notebooks OR Python source
- Maintains backward compatibility: tinytorch package unchanged

Tested:
- Single module export: tito export 01_tensor 
- All modules export: tito export --all 
- Package imports: from tinytorch.core.tensor import Tensor 
- 20/20 modules successfully converted and exported
2025-11-25 00:02:21 -05:00
Vijay Janapa Reddi
68131e6be0 Add comprehensive JSON format documentation for progress tracking
Documents all JSON formats used for module progress, milestones, and system status. Includes combined export format for website integration and API endpoint suggestions.
2025-11-24 21:19:22 -05:00
Vijay Janapa Reddi
1517c6f83d Clean up repository by removing planning and status documents
Removed 42 planning, brainstorming, and status tracking documents that served their purpose during development but are no longer needed for release.

Changes:
- Root: Removed 4 temporary/status files
- binder/: Removed 20 planning documents (kept essential setup files)
- docs/: Removed 16 planning/status documents (preserved all user-facing docs and website dependencies)
- tests/: Removed 2 status documents (preserved all test docs and milestone system)

Preserved files:
- All user-facing documentation (README, guides, quickstarts)
- All website dependencies (INSTRUCTOR_GUIDE, PRIVACY_DATA_RETENTION, TEAM_ONBOARDING)
- All functional configuration files
- All milestone system documentation (7 files in tests/milestones/)

Updated .gitignore to prevent future accumulation of internal development files (.claude/, site/_build/, log files, progress.json)
2025-11-22 21:05:57 -05:00
Vijay Janapa Reddi
d719617c7b Update expert analysis to reflect final baseline design decision 2025-11-20 00:18:15 -05:00
Vijay Janapa Reddi
97e0563614 Add community and benchmark features with baseline validation
- Implement tito benchmark baseline and capstone commands
- Add SPEC-style normalization for baseline benchmarks
- Implement tito community join, update, leave, stats, profile commands
- Use project-local storage (.tinytorch/) for user data
- Add privacy-by-design with explicit consent prompts
- Update site documentation for community and benchmark features
- Add Marimo integration for online notebooks
- Clean up redundant milestone setup exploration docs
- Finalize baseline design: fast setup validation (~1 second) with normalized results
2025-11-20 00:17:21 -05:00
Vijay Janapa Reddi
902af7e366 Remove references to non-existent documentation files 2025-11-19 22:03:57 -05:00
Vijay Janapa Reddi
90d472913b Remove temporary documentation and planning files
Deleted Category 1 temporary documentation files:
- Root directory: review reports, fix summaries, implementation checklists
- docs/development: testing plans, review checklists, quick references
- instructor/guides: analysis reports and implementation plans
- tests: testing strategy document

These were completed work logs and planning documents no longer needed.
All active documentation (site content, module ABOUT files, READMEs) preserved.
2025-11-19 16:21:24 -05:00
Vijay Janapa Reddi
f31865560e Add enumitem package to fix itemize formatting
The itemize environment parameters [leftmargin=*, itemsep=1pt, parsep=0pt]
were appearing as visible text in the PDF because the enumitem package
wasn't loaded. This fix adds \usepackage{enumitem} to the preamble.

All itemized lists now format correctly with proper spacing and margins.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-19 08:43:41 -05:00
Vijay Janapa Reddi
d4dcf4f046 Apply all remaining critical fixes: tinygrad citation, NBGrader format, hedging, consistency 2025-11-18 09:39:19 -05:00
Vijay Janapa Reddi
a13b4f7244 Improve SIGCSE paper with reviewer feedback and clean up repository
Paper improvements:
- Add differentiated time estimates (60-80h experienced, 100-120h typical, 140-180h struggling)
- Moderate cognitive load claims with hedging language and empirical validation notes
- Add ML Systems Research subsection with citations (Baydin AD survey, Chen gradient checkpointing, TVM, FlashAttention)
- Add comprehensive Threats to Validity section (selection bias, single institution, demand characteristics, no control group, maturation, assessment validity)
- Define jargon (monkey-patching) at first use with clear explanation

Documentation updates:
- Restructure TITO CLI docs into dedicated section (overview, modules, milestones, data, troubleshooting)
- Update student workflow guide and quickstart guide
- Remove deprecated files (testing-framework.md, tito-essentials.md)
- Update module template and testing architecture docs

Repository cleanup:
- Remove temporary review files (ADDITIONAL_REVIEWS.md, EDTECH_OPENSOURCE_REVIEWS.md, TA_STRUGGLING_STUDENT_REVIEWS.md, etc.)
- Remove temporary development planning docs
- Update demo GIFs and configurations
2025-11-16 23:46:38 -05:00
Vijay Janapa Reddi
b56af30ba7 Update development documentation and workflow files
- Update GitHub workflow for publishing
- Update December 2024 release notes
- Update module about template and testing documentation
- Update milestone template
2025-11-14 08:28:24 -05:00
Vijay Janapa Reddi
b9f142b2d8 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
cb3476702e Add comprehensive testing plan documentation
- Add TESTING_QUICK_REFERENCE.md for quick access to common testing commands
- Add comprehensive-module-testing-plan.md with module-by-module test requirements
- Add gradient-flow-testing-strategy.md for gradient flow test coverage analysis
- Add testing-architecture.md explaining two-tier testing approach
- Update TEST_STRATEGY.md to reference master testing plan

These documents define clear boundaries between unit tests (modules/),
integration tests (tests/), and milestones, with comprehensive coverage
analysis and implementation roadmap.
2025-11-12 07:29:55 -05:00
Vijay Janapa Reddi
cb5ad9ccf1 Cleanup: Remove old/unused files
- Remove datasets analysis and download scripts (replaced by updated README)
- Remove archived book development documentation
- Remove module review reports (16_compression, 17_memoization)
2025-11-11 19:04:56 -05:00
Vijay Janapa Reddi
78d0ca6afc Remove redundant review documentation
Removed redundant and superseded review reports:
- Module 15: COMPREHENSIVE_REVIEW_REPORT.md, FINAL_VALIDATION_REPORT.md, REVIEW_SUMMARY.md
- Docs: RESTRUCTURING_VERIFICATION.md, book-development/CLEANUP_SUMMARY.md

Also removed untracked files:
- Module 11: REVIEW_REPORT_FINAL.md (superseded by REVIEW_REPORT.md)
- Module 12: REVIEW_SUMMARY.md (redundant with REVIEW_REPORT.md)
- Module 20: COMPLIANCE_CHECKLIST.md (redundant with REVIEW_REPORT.md)
- Module 6, 8, 14, 18: COMPLIANCE_SUMMARY.md and QUICK_SUMMARY.md files

Retained comprehensive REVIEW_REPORT.md files which contain the most complete QA documentation.
2025-11-11 12:15:36 -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
757d50b717 docs: update module references in README and guides
- Update README.md module structure (14→Profiling, 15→Memoization)
- Fix tier descriptions (10-13 Architecture, 14-19 Optimization)
- Update Module 13 next steps to reference Module 15
- Fix Module 15 prerequisite reference to Module 14
- Correct cifar10-training-guide module numbers
2025-11-09 12:42:27 -05:00