Don't know how, but despite not working on it for well over a year I've managed to remember what most things do.
However, it'd still be nice to have some README's in the sub-directories which explain roughly what everything does.
Some solutions were not as trivial (for instance, Name required a few iterations to get working).
Therefore, having README's in a few key locations would help.
But generally we should stick to high-level directories so that they're easy to find.
But the idea is similar to #250 , we want key documentation to live alongside the (relevant) code instead of a separate location which is much harder to maintain and more likely to become outdated.
That feels way more rigid anyway.
Perhaps in the future we could somehow extract the README's from the codebase using an automated pipeline somewhere else?
Don't know how, but despite not working on it for well over a year I've managed to remember what most things do. However, it'd still be nice to have some README's in the sub-directories which explain roughly what everything does. Some solutions were not as trivial (for instance,
Namerequired a few iterations to get working). Therefore, having README's in a few key locations would help.But generally we should stick to high-level directories so that they're easy to find. But the idea is similar to #250 , we want key documentation to live alongside the (relevant) code instead of a separate location which is much harder to maintain and more likely to become outdated. That feels way more rigid anyway. Perhaps in the future we could somehow extract the README's from the codebase using an automated pipeline somewhere else?