trifectatechfoundation / teach-rs

A modular, reusable university course for Rust
https://teach-rs.trifectatech.org
Creative Commons Attribution Share Alike 4.0 International
2.97k stars 140 forks source link

Introduction tells you to clone the repository instead of using the generated exercises zip from the website #129

Open michielp1807 opened 2 weeks ago

michielp1807 commented 2 weeks ago

The introduction tells you to clone the repository to get access to the exercises. However, if you do this, the paths described in the exercises do not match the folder layout, as the exercises assume the folder layout of the generated exercises zip from the main page of the website.

For example, for Exercise 2.3.1, it says to follow the instructions of exercises/2-foundations-of-rust/3-advanced-syntax/1-error-propagation/src/main.rs. However, the exercise is actually located in content/mods/A-foundations/topics/optionals-errors/exercises/error-propagation/src/main.rs in the cloned repository. And similarly for the other exercises.

hdoordt commented 2 weeks ago

This might be more of a documentation issue, because this is intentional: the paths refer to the exercise structure in the generated exercise package. Modmod is used to take the content in the content folder and put it in the right place according to the given track specification. You can download the exercise package corresponding to your track here: https://teach-rs.trifectatech.org/

michielp1807 commented 2 weeks ago

Ah right, that makes sense. We might need to change the introduction, which currently tells you to clone the GitHub repo instead of downloading the generated exercise package.

hdoordt commented 2 weeks ago

Good call. Reopening this again

hdoordt commented 1 week ago

@MichielP1807 can you update the title to match the actual issue of the introduction content not reflecting reality?