Commit Graph

12 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
850a91adc6 fix(docs): align notebook filenames with tito convention across all docs
Notebooks use short names (tensor.ipynb, not 01_tensor.ipynb) but docs
and Binder postBuild scripts used the prefixed form. This caused broken
Binder links and incorrect paths in troubleshooting guides.

Fixes: harvard-edge/cs249r_book#1176
2026-02-17 18:31:44 -05:00
Vijay Janapa Reddi
9f2cce16d2 fix(docs): update TITO reference docs to match actual CLI commands
- Fix setup flow across all docs (activate.sh → source .venv/bin/activate,
  setup-environment.sh → tito setup)
- Add missing commands to overview (tito setup, system update/reset,
  module list/view/test, milestone test/demo, nbgrader commands)
- Add module list, view, and test sections to modules.md
- Fix phantom AlexNet milestone → XOR Crisis in data.md
- Fix Module 10 name (Normalization → Tokenization) in data.md
- Fix milestones.md prereq check output (missing Module 08)
- Fix troubleshooting.md paths, permission fix, and quick-reference table
2026-02-16 14:30:44 -05:00
Vijay Janapa Reddi
0f67780f5a feat: enable Windows support by default with Git Bash
- CI now runs both Linux and Windows by default (matrix)
- Updated install.sh to detect Windows venv path (Scripts/ vs bin/)
- Added Windows installation instructions to getting-started.md
- Updated troubleshooting guide with Git Bash guidance
- Windows uses Git Bash for cross-platform bash script compatibility
2026-01-26 10:02:27 -05:00
Vijay Janapa Reddi
8a259e4a42 docs(tinytorch): reorganize site navigation and add update documentation
- Reorganize TOC: move datasets from TITO CLI to new Reference section
- Add complete TITO CLI Reference section to PDF build (was missing)
- Add System Updates section to troubleshooting guide with code safety info
- Fix datasets.md styling for consistency (add border-radius to all boxes)
- Improve logical flow: TITO CLI → Reference → Community

Changes:
- HTML TOC: Create Reference section, move datasets + resources
- PDF TOC: Add full TITO CLI section (overview, modules, milestones, data, troubleshooting)
- troubleshooting.md: Add 4 new sections on updating TinyTorch safely
- datasets.md: Standardize styling with rounded corners

Result: Clean separation between workflow docs (TITO CLI) and reference materials
2026-01-17 10:39:49 -05:00
Vijay Janapa Reddi
eec214e335 fix: resolve Jupyter Book build warnings and PDF diagram readability
- Fix broken symlink for 09_convolutions_ABOUT.md
- Fix header level warnings (H1 to H3 jumps) in community.md and intro.md
- Remove broken cross-references to deleted files across site pages
- Fix lexing errors by using text blocks for Unicode characters
- Update mermaid diagram in big-picture.md to use light fill colors
  for PDF compatibility (mermaid-cli does not respect inline color styles)
2025-12-14 14:58:47 -05:00
Vijay Janapa Reddi
fcf3d8bd12 fix: update all GitHub URLs from mlsysbook/TinyTorch to harvard-edge/cs249r_book
- Update all repository references to point to harvard-edge/cs249r_book
- Fix Binder URLs to include tinytorch/ path prefix
- Fix Colab URLs to include tinytorch/ path prefix
- Update marimo-badges.js with correct repo and path
- Fix dataset documentation URLs
- Update module ABOUT.md files with correct source links

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2025-12-14 12:36:10 -05:00
Vijay Janapa Reddi
69a3e19f2f style: rebrand "Your TinyTorch" to "Your Tiny🔥Torch" across codebase
Consistent branding with flame emoji in all module ABOUTs,
milestone files, site documentation, and Python scripts.
2025-12-13 15:23:28 -05:00
Vijay Janapa Reddi
5e26319fbc style: remove extra blank lines from markdown files
Clean up documentation by collapsing multiple consecutive blank lines
into single blank lines for consistency.
2025-12-13 13:32:53 -05:00
Vijay Janapa Reddi
d21dd1dca0 fix: correct invalid tito CLI commands in documentation
- Fix 56+ invalid CLI references across markdown files
- Replace nonexistent commands with valid alternatives:
  - tito checkpoint → tito module status
  - tito milestones → tito milestone
  - tito system check/doctor → tito system health
  - tito community leave → tito community logout
  - tito reset all → tito module reset XX
  - tito status → tito module status / tito milestone status
- Add pre-commit hook to prevent future CLI documentation drift
- Organize pre-commit config for monorepo (book + tinytorch sections)
2025-12-12 15:56:26 -05:00
Vijay Janapa Reddi
ddf651970f refactor(tito): remove doctor alias, use health as single command
Remove the doctor/health alias duplication in favor of a single
'tito system health' command for environment validation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2025-12-11 12:34:28 -08:00
Vijay Janapa Reddi
00f1e8588a fix(docs): replace LaTeX textcolor commands in site documentation
- Convert remaining LaTeX markup to Unicode symbols
- \textcolor{green!60!black}{$\sim$} → ~
- \textcolor{torchnavy}{$\nearrow$} → ↗
- \textcolor{torchnavy}{$\triangleright$} → ▶
2025-12-07 13:39:54 -08:00
Vijay Janapa Reddi
c602f97364 feat: integrate TinyTorch into MLSysBook repository
TinyTorch educational deep learning framework now lives at tinytorch/

Structure:
- tinytorch/src/         - Source modules (single source of truth)
- tinytorch/tito/        - CLI tool
- tinytorch/tests/       - Test suite
- tinytorch/site/        - Jupyter Book website
- tinytorch/milestones/  - Historical ML implementations
- tinytorch/datasets/    - Educational datasets (tinydigits, tinytalks)
- tinytorch/assignments/ - NBGrader assignments
- tinytorch/instructor/  - Teaching materials

Workflows (with tinytorch- prefix):
- tinytorch-ci.yml           - CI/CD pipeline
- tinytorch-publish-dev.yml  - Dev site deployment
- tinytorch-publish-live.yml - Live site deployment
- tinytorch-build-pdf.yml    - PDF generation
- tinytorch-release-check.yml - Release validation

Repository Variables added:
- TINYTORCH_ROOT  = tinytorch
- TINYTORCH_SRC   = tinytorch/src
- TINYTORCH_SITE  = tinytorch/site
- TINYTORCH_TESTS = tinytorch/tests

All workflows use \${{ vars.TINYTORCH_* }} for path configuration.

Note: tinytorch/site/_static/favicon.svg kept as SVG (valid for favicons)
2025-12-05 19:23:18 -08:00