Documentation?

[mrshirts]

There should be a bit more explanation of what is expected to / not expected to run for external users. The examples_repr and examples_DPD don't have a README.md, for example. If people are not expected to be able to run these, I think they should at least have a stub README.md that says so?

[timbernat]

Can you provide some clarification on what you'd expect to see here? None of the collections of examples have dedicated READMEs currently (including examples_system as well), but the subset of examples which are intended to be run are highlighted on the main repo README, in the order they are intended to be executed. examples_DPD is omitted from the README to discourage them from being run, but that can be made more explicit.

As a first pass, how would you feel about:

1. Having " index" notebooks in each directory which essentially mirror the order + desc info in the README for each subdirectory (similar to what's done here)
2. Moving the DPD examples to a separate branch (don't want to delete those yet!!) and withdrawing then from main

Beyond that, what other documentation improvements do you think would aid in navigating these examples?

[mrshirts]

Maybe we should have the other students go through and say what they needed for a README.md!

[StephMcCallum]

I like the idea of indexing the notebooks. It would also be helpful if the titles in the README match the notebook document names (including their index).

I agree that what's in examples_DPD is different from mupt tutorials and can be moved to a branch until those are integrated with a mupt representation. Any unfinished notebooks in other folders should also be moved to a new branch to have a clean repo where all notebooks can be ran.

I'm okay with the README index of examples and short descriptions in the main repo.