From d2cfb2d57e66a14ed55252aa42b945f0216bd49b Mon Sep 17 00:00:00 2001 From: Vijay Janapa Reddi Date: Sat, 27 Sep 2025 17:04:19 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20Major=20cleanup=20-=2046=20=E2=86=92=20?= =?UTF-8?q?12=20essential=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MASSIVE DOCUMENTATION CLEANUP: - Reduced from 46 docs to 12 essential files - Archived 34 outdated planning and analysis documents ✅ KEPT (Essential for current operations): - STUDENT_QUICKSTART.md - Student onboarding - INSTRUCTOR_GUIDE.md - Instructor setup - cifar10-training-guide.md - North star achievement - tinytorch-assumptions.md - Complexity framework (NEW) - tinytorch-textbook-alignment.md - Academic alignment - NBGrader integration docs (3 files) - Development standards (3 files) - docs/README.md - Navigation guide (NEW) 🗑️ ARCHIVED (Completed/outdated planning): - All optimization-modules-* planning docs - All milestone-* system docs - All tutorial-master-plan and analysis docs - Module reordering and structure analysis - Agent setup and workflow case studies RESULT: Clean, focused documentation structure Only active, current docs remain - easy to find what you need! --- docs/README.md | 35 +++++++++++++++++++ .../2024-cleanup}/15-module-structure.md | 0 .../2024-cleanup}/AGENT_SETUP_PROMPT.md | 0 .../2024-cleanup}/MASTER_PLAN_OF_RECORD.md | 0 .../2024-cleanup}/PACKAGE_MANAGER_AGENT.md | 0 .../REORGANIZATION_MIGRATION_GUIDE.md | 0 .../agent_workflow_case_study.md | 0 .../beautiful-module-progression-analysis.md | 0 .../2024-cleanup}/complete-beautiful-flow.md | 0 .../instructor-milestone-guide.md | 0 .../leaderboard-join-experience.md | 0 .../milestone-implementation-guide.md | 0 .../milestone-system-overview.md | 0 .../2024-cleanup}/milestone-system.md | 0 .../milestone-troubleshooting.md | 0 .../2024-cleanup}/module-audit.md | 0 .../2024-cleanup}/module-plan-final.md | 0 .../2024-cleanup}/module-reordering-plan.md | 0 .../modules-15-20-detailed-outline.md | 0 .../optimization-module-naming-analysis.md | 0 .../optimization-modules-development-plan.md | 0 ...ptimization-modules-implementation-plan.md | 0 .../optimization-modules-tasks-remaining.md | 0 .../optimization-modules-tutorial-plan.md | 0 .../2024-cleanup}/shared-testing-pattern.md | 0 .../2024-cleanup}/testing_pattern.md | 0 .../2024-cleanup}/three-part-structure.md | 0 .../training-systems-ordering-analysis.md | 0 .../tutorial-design-rationale.md | 0 .../2024-cleanup}/tutorial-master-plan-v2.md | 0 .../website-content-strategy-assessment.md | 0 31 files changed, 35 insertions(+) create mode 100644 docs/README.md rename docs/{ => archive/2024-cleanup}/15-module-structure.md (100%) rename docs/{development => archive/2024-cleanup}/AGENT_SETUP_PROMPT.md (100%) rename docs/{ => archive/2024-cleanup}/MASTER_PLAN_OF_RECORD.md (100%) rename docs/{development => archive/2024-cleanup}/PACKAGE_MANAGER_AGENT.md (100%) rename docs/{ => archive/2024-cleanup}/REORGANIZATION_MIGRATION_GUIDE.md (100%) rename docs/{ => archive/2024-cleanup}/agent_workflow_case_study.md (100%) rename docs/{ => archive/2024-cleanup}/beautiful-module-progression-analysis.md (100%) rename docs/{ => archive/2024-cleanup}/complete-beautiful-flow.md (100%) rename docs/{ => archive/2024-cleanup}/instructor-milestone-guide.md (100%) rename docs/{ => archive/2024-cleanup}/leaderboard-join-experience.md (100%) rename docs/{ => archive/2024-cleanup}/milestone-implementation-guide.md (100%) rename docs/{ => archive/2024-cleanup}/milestone-system-overview.md (100%) rename docs/{ => archive/2024-cleanup}/milestone-system.md (100%) rename docs/{ => archive/2024-cleanup}/milestone-troubleshooting.md (100%) rename docs/{ => archive/2024-cleanup}/module-audit.md (100%) rename docs/{ => archive/2024-cleanup}/module-plan-final.md (100%) rename docs/{ => archive/2024-cleanup}/module-reordering-plan.md (100%) rename docs/{ => archive/2024-cleanup}/modules-15-20-detailed-outline.md (100%) rename docs/{ => archive/2024-cleanup}/optimization-module-naming-analysis.md (100%) rename docs/{ => archive/2024-cleanup}/optimization-modules-development-plan.md (100%) rename docs/{ => archive/2024-cleanup}/optimization-modules-implementation-plan.md (100%) rename docs/{ => archive/2024-cleanup}/optimization-modules-tasks-remaining.md (100%) rename docs/{ => archive/2024-cleanup}/optimization-modules-tutorial-plan.md (100%) rename docs/{development => archive/2024-cleanup}/shared-testing-pattern.md (100%) rename docs/{ => archive/2024-cleanup}/testing_pattern.md (100%) rename docs/{ => archive/2024-cleanup}/three-part-structure.md (100%) rename docs/{ => archive/2024-cleanup}/training-systems-ordering-analysis.md (100%) rename docs/{ => archive/2024-cleanup}/tutorial-design-rationale.md (100%) rename docs/{ => archive/2024-cleanup}/tutorial-master-plan-v2.md (100%) rename docs/{ => archive/2024-cleanup}/website-content-strategy-assessment.md (100%) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..ae183c18 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,35 @@ +# TinyTorch Documentation + +This directory contains essential documentation for TinyTorch development and usage. + +## 📚 User Documentation + +- **`STUDENT_QUICKSTART.md`** - Getting started guide for students +- **`INSTRUCTOR_GUIDE.md`** - Setup and grading guide for instructors +- **`cifar10-training-guide.md`** - Complete guide to achieving the north star goal (75% CIFAR-10 accuracy) + +## 🔧 Development Documentation + +- **`tinytorch-assumptions.md`** - **CRITICAL**: TinyTorch complexity framework and implementation guidelines +- **`tinytorch-textbook-alignment.md`** - Alignment with ML systems textbooks + +### Development Standards +- **`development/module-rules.md`** - Module development standards and patterns +- **`development/nbgrader-standardized-testing.md`** - Testing standards +- **`development/nbgrader-testing-template.md`** - Testing templates + +### NBGrader Integration +- **`nbgrader/NBGrader_Quick_Reference.md`** - Daily use commands and workflow +- **`nbgrader/NBGRADER_STYLE_GUIDE.md`** - Style guide for NBGrader cells +- **`nbgrader/NBGrader_Text_Response_Technical_Implementation.md`** - Technical implementation details + +## 📦 Archive + +The `archive/` directory contains historical documentation that's no longer actively maintained but preserved for reference. + +--- + +**Start here**: +- **Students**: Read `STUDENT_QUICKSTART.md` +- **Instructors**: Read `INSTRUCTOR_GUIDE.md` +- **Developers**: Read `tinytorch-assumptions.md` FIRST, then `development/module-rules.md` \ No newline at end of file diff --git a/docs/15-module-structure.md b/docs/archive/2024-cleanup/15-module-structure.md similarity index 100% rename from docs/15-module-structure.md rename to docs/archive/2024-cleanup/15-module-structure.md diff --git a/docs/development/AGENT_SETUP_PROMPT.md b/docs/archive/2024-cleanup/AGENT_SETUP_PROMPT.md similarity index 100% rename from docs/development/AGENT_SETUP_PROMPT.md rename to docs/archive/2024-cleanup/AGENT_SETUP_PROMPT.md diff --git a/docs/MASTER_PLAN_OF_RECORD.md b/docs/archive/2024-cleanup/MASTER_PLAN_OF_RECORD.md similarity index 100% rename from docs/MASTER_PLAN_OF_RECORD.md rename to docs/archive/2024-cleanup/MASTER_PLAN_OF_RECORD.md diff --git a/docs/development/PACKAGE_MANAGER_AGENT.md b/docs/archive/2024-cleanup/PACKAGE_MANAGER_AGENT.md similarity index 100% rename from docs/development/PACKAGE_MANAGER_AGENT.md rename to docs/archive/2024-cleanup/PACKAGE_MANAGER_AGENT.md diff --git a/docs/REORGANIZATION_MIGRATION_GUIDE.md b/docs/archive/2024-cleanup/REORGANIZATION_MIGRATION_GUIDE.md similarity index 100% rename from docs/REORGANIZATION_MIGRATION_GUIDE.md rename to docs/archive/2024-cleanup/REORGANIZATION_MIGRATION_GUIDE.md diff --git a/docs/agent_workflow_case_study.md b/docs/archive/2024-cleanup/agent_workflow_case_study.md similarity index 100% rename from docs/agent_workflow_case_study.md rename to docs/archive/2024-cleanup/agent_workflow_case_study.md diff --git a/docs/beautiful-module-progression-analysis.md b/docs/archive/2024-cleanup/beautiful-module-progression-analysis.md similarity index 100% rename from docs/beautiful-module-progression-analysis.md rename to docs/archive/2024-cleanup/beautiful-module-progression-analysis.md diff --git a/docs/complete-beautiful-flow.md b/docs/archive/2024-cleanup/complete-beautiful-flow.md similarity index 100% rename from docs/complete-beautiful-flow.md rename to docs/archive/2024-cleanup/complete-beautiful-flow.md diff --git a/docs/instructor-milestone-guide.md b/docs/archive/2024-cleanup/instructor-milestone-guide.md similarity index 100% rename from docs/instructor-milestone-guide.md rename to docs/archive/2024-cleanup/instructor-milestone-guide.md diff --git a/docs/leaderboard-join-experience.md b/docs/archive/2024-cleanup/leaderboard-join-experience.md similarity index 100% rename from docs/leaderboard-join-experience.md rename to docs/archive/2024-cleanup/leaderboard-join-experience.md diff --git a/docs/milestone-implementation-guide.md b/docs/archive/2024-cleanup/milestone-implementation-guide.md similarity index 100% rename from docs/milestone-implementation-guide.md rename to docs/archive/2024-cleanup/milestone-implementation-guide.md diff --git a/docs/milestone-system-overview.md b/docs/archive/2024-cleanup/milestone-system-overview.md similarity index 100% rename from docs/milestone-system-overview.md rename to docs/archive/2024-cleanup/milestone-system-overview.md diff --git a/docs/milestone-system.md b/docs/archive/2024-cleanup/milestone-system.md similarity index 100% rename from docs/milestone-system.md rename to docs/archive/2024-cleanup/milestone-system.md diff --git a/docs/milestone-troubleshooting.md b/docs/archive/2024-cleanup/milestone-troubleshooting.md similarity index 100% rename from docs/milestone-troubleshooting.md rename to docs/archive/2024-cleanup/milestone-troubleshooting.md diff --git a/docs/module-audit.md b/docs/archive/2024-cleanup/module-audit.md similarity index 100% rename from docs/module-audit.md rename to docs/archive/2024-cleanup/module-audit.md diff --git a/docs/module-plan-final.md b/docs/archive/2024-cleanup/module-plan-final.md similarity index 100% rename from docs/module-plan-final.md rename to docs/archive/2024-cleanup/module-plan-final.md diff --git a/docs/module-reordering-plan.md b/docs/archive/2024-cleanup/module-reordering-plan.md similarity index 100% rename from docs/module-reordering-plan.md rename to docs/archive/2024-cleanup/module-reordering-plan.md diff --git a/docs/modules-15-20-detailed-outline.md b/docs/archive/2024-cleanup/modules-15-20-detailed-outline.md similarity index 100% rename from docs/modules-15-20-detailed-outline.md rename to docs/archive/2024-cleanup/modules-15-20-detailed-outline.md diff --git a/docs/optimization-module-naming-analysis.md b/docs/archive/2024-cleanup/optimization-module-naming-analysis.md similarity index 100% rename from docs/optimization-module-naming-analysis.md rename to docs/archive/2024-cleanup/optimization-module-naming-analysis.md diff --git a/docs/optimization-modules-development-plan.md b/docs/archive/2024-cleanup/optimization-modules-development-plan.md similarity index 100% rename from docs/optimization-modules-development-plan.md rename to docs/archive/2024-cleanup/optimization-modules-development-plan.md diff --git a/docs/optimization-modules-implementation-plan.md b/docs/archive/2024-cleanup/optimization-modules-implementation-plan.md similarity index 100% rename from docs/optimization-modules-implementation-plan.md rename to docs/archive/2024-cleanup/optimization-modules-implementation-plan.md diff --git a/docs/optimization-modules-tasks-remaining.md b/docs/archive/2024-cleanup/optimization-modules-tasks-remaining.md similarity index 100% rename from docs/optimization-modules-tasks-remaining.md rename to docs/archive/2024-cleanup/optimization-modules-tasks-remaining.md diff --git a/docs/optimization-modules-tutorial-plan.md b/docs/archive/2024-cleanup/optimization-modules-tutorial-plan.md similarity index 100% rename from docs/optimization-modules-tutorial-plan.md rename to docs/archive/2024-cleanup/optimization-modules-tutorial-plan.md diff --git a/docs/development/shared-testing-pattern.md b/docs/archive/2024-cleanup/shared-testing-pattern.md similarity index 100% rename from docs/development/shared-testing-pattern.md rename to docs/archive/2024-cleanup/shared-testing-pattern.md diff --git a/docs/testing_pattern.md b/docs/archive/2024-cleanup/testing_pattern.md similarity index 100% rename from docs/testing_pattern.md rename to docs/archive/2024-cleanup/testing_pattern.md diff --git a/docs/three-part-structure.md b/docs/archive/2024-cleanup/three-part-structure.md similarity index 100% rename from docs/three-part-structure.md rename to docs/archive/2024-cleanup/three-part-structure.md diff --git a/docs/training-systems-ordering-analysis.md b/docs/archive/2024-cleanup/training-systems-ordering-analysis.md similarity index 100% rename from docs/training-systems-ordering-analysis.md rename to docs/archive/2024-cleanup/training-systems-ordering-analysis.md diff --git a/docs/tutorial-design-rationale.md b/docs/archive/2024-cleanup/tutorial-design-rationale.md similarity index 100% rename from docs/tutorial-design-rationale.md rename to docs/archive/2024-cleanup/tutorial-design-rationale.md diff --git a/docs/tutorial-master-plan-v2.md b/docs/archive/2024-cleanup/tutorial-master-plan-v2.md similarity index 100% rename from docs/tutorial-master-plan-v2.md rename to docs/archive/2024-cleanup/tutorial-master-plan-v2.md diff --git a/docs/website-content-strategy-assessment.md b/docs/archive/2024-cleanup/website-content-strategy-assessment.md similarity index 100% rename from docs/website-content-strategy-assessment.md rename to docs/archive/2024-cleanup/website-content-strategy-assessment.md