JOSE Review: repository organization & ordering notebooks

[TomDonoghue]

This issue / suggestion is related to the JOSE review.

I would recommend potentially organizing the files in the repository a bit more, with two particular goals:

• currently, the order and organization of materials isn't particularly obvious
  • for example, if one just follows the "Binder" or "Collab" links from the README link, it's not clear which notebooks to start with
  • In particular, following the Binder link, we see an un-ordered list of all files, and I don't think it's clear how to proceed / interact with these files in a sensible ordering, if one wants to work through the materials interactively
• for anyone looking to use / deploy this resource in a course, the organization of materials isn't very obvious
  • I think it would be easier for a potential teacher to see what's what by having organized sub-folders of different types of things

Related notes:

• there are Markdown files that I think come from the JupyterBook tempate (ex content.md, markdown.md), and I think are not used. Can these be deleted?
• content files could be organized into their own sub-folder
  • for example, for images, in this kind of repo, I tend to use an img/ sub-folder
  • overall, you could use something like img/, data/, markdown/ sub-folders for different aspects of the content
• I think the JOSE paper could also be moved to a sub-folder, so it's clear this is separate from the textbook content
  • this would also help to group related files together
• assuming there is an explicit numbering to the notebooks, using leading numbers (eg 01, 02) in the titles would automatically sort these files, and make the order clear
• the .DS_Store and .ipynb_checkpoints files can presumably be deleted

Some of this file movements might require checking file paths for building and deploying the book, but I think it should all work.

[valdanchev]

Agree @TomDonoghue, the resource repository could be better organised indeed. Your thoughtful suggestions will help me greatly to improve the structure of the content.

[valdanchev]

Following the very helpful suggestions, the files are now reorganised in the repository and ordered in a structured way:

• different types of content are now assigned to sub-folders notebooks/, images/, data/, JOSE_paper/;
• notebooks are sorted in ascending order in folder notebooks/
• unused/unnecessary files are deleted

As a result, the organisation of the repository for the learning resource, including notebooks' sequential order, looks much more intuitive and structured.

[TomDonoghue]

Updates / reorganizations here all look good to me!