comprehensive-rust icon indicating copy to clipboard operation
comprehensive-rust copied to clipboard

Source tree admin - put each sub-class in its own directory?

Open timClicks opened this issue 4 months ago • 4 comments

At the moment, each session lives in its own directory within src. As an instructor, I have found this hard to navigate. Most specifically, I've found it hard to find the concurrency module when I've been trying to do so on the fly.

src
  android
  bare-metal
  borrowing
  cargo
  ...
  concurrency
  

I would personally like to see the sessions within the Rust Fundamentals, i.e. the main course, be put into their own directory. We could also create a welcome module for the prelude material. Something like this:

src
  android
  bare-metal
  chromium
  concurrency
  fundamentals
    borrowing 
    cargo
    ...
  welcome
 ...

timClicks avatar Jul 03 '25 03:07 timClicks

I like this idea! It would need some work to handle redirects from old to new locations, but otherwise shouldn't be too much trouble.

djmitche avatar Jul 03 '25 03:07 djmitche

+1 to the idea, and I believe the hesitation to move things around is coming from the desire to keep old links working. @mgeisler was putting in a non-trivial amount of work to add redirects each time the files were moved (esp. during the refactoring of the class structure from v1 to v2). As long as the redirects are added, there should be no downside to adding subdirectories.

See comprehensive-rust/book.toml for the redirect mechanism.

gribozavr avatar Jul 07 '25 13:07 gribozavr

When I did the v2 reorg, I used a bit of scripting to generate the redirects (and resolve any redirect-to-a-redirect). I imagine that would be even easier here.

djmitche avatar Jul 07 '25 14:07 djmitche

Hey folks! Reorganizing things is a nice idea!

I've found it hard to find the concurrency module when I've been trying to do so on the fly.

I must admit that I'm just searching (pressing s on any page) for chapters when I need to find something quick. The search seems heavily biased towards headings, so this works well in most cases. Here it's the second match:

Image

So s, down, down, enter brings me to the Concurrency deep dive.

Note that moving files around has little impact, as long as redirects are added as needed. A slightly different idea would be to split the big monolithic course into separate mdbook books... That would have some pros (easier to navigate, more self-contained) but also some cons (no quick jumping between courses).

mgeisler avatar Sep 04 '25 22:09 mgeisler