Description
The README recommends using sparse checkout to avoid downloading 50+ translations:
git sparse-checkout set --no-cone '/*' '!translations' '!translated_images'
Problem: Several lessons reference images and starter files that live inside translations/ even for the English course. Example: 1-getting-started-lessons/3-accessibility/translations/README.md contains the main lesson for some languages, but 1-getting-started-lessons/3-accessibility/assignment.md links to ./images/terrarium.png which only exists in translated_images/espanol/images/.
Result: Students following the sparse checkout steps get broken images and missing starter files for lessons like the terrarium, space game, and browser extension. They think the repo is broken.
Proposed Solution
-
Audit lesson dependencies: Move all required assets for the default English track out of translations/ and translated_images/ into each lesson folder.
-
Update sparse checkout command: If some shared assets must stay in translated_images, change the command to:
git sparse-checkout set --no-cone '/*' '!translations' 'translated_images/english'
Or keep a /assets folder at root with all required images.
-
Add warning: Note in README that sparse checkout will break specific lessons unless assets are included.
-
CI check: Add GitHub Action to fail if any _.md in default lessons links to a path excluded by the recommended sparse checkout.
Acceptance Criteria
Technical Notes
Affected lessons so far: terrarium project, typing-game, browser-extension. All link to images under translated_images/. The course is “project-based” so broken assets block completion.
Priority:High — breaks onboarding for beginners, which is the core audience
Labels: bug, documentation, good-first-issue, help-wanted
Description
The README recommends using sparse checkout to avoid downloading 50+ translations:
git sparse-checkout set --no-cone '/*' '!translations' '!translated_images'
Problem: Several lessons reference images and starter files that live inside
translations/even for the English course. Example:1-getting-started-lessons/3-accessibility/translations/README.mdcontains the main lesson for some languages, but1-getting-started-lessons/3-accessibility/assignment.mdlinks to./images/terrarium.pngwhich only exists intranslated_images/espanol/images/.Result: Students following the sparse checkout steps get broken images and missing starter files for lessons like the terrarium, space game, and browser extension. They think the repo is broken.
Proposed Solution
Audit lesson dependencies: Move all required assets for the default English track out of
translations/andtranslated_images/into each lesson folder.Update sparse checkout command: If some shared assets must stay in
translated_images, change the command to:git sparse-checkout set --no-cone '/*' '!translations' 'translated_images/english'
Or keep a
/assetsfolder at root with all required images.Add warning: Note in README that sparse checkout will break specific lessons unless assets are included.
CI check: Add GitHub Action to fail if any
_.mdin default lessons links to a path excluded by the recommended sparse checkout.Acceptance Criteria
.mdin the English path referencestranslations/ortranslated_images/find . -name "_.html" -o -name "*.md" | xargs grep "src=" | grep "404"returns nothingTechnical Notes
Affected lessons so far:
terrariumproject,typing-game,browser-extension. All link to images undertranslated_images/. The course is “project-based” so broken assets block completion.Priority:High — breaks onboarding for beginners, which is the core audience
Labels:
bug,documentation,good-first-issue,help-wanted