Riverscapes
Help links in the file system
This is only pie-in-the-sky talk right now.
Someone at the workshop asked for a readme file in each folder telling us what each file was.
I'm not really in favour of this since it creates a lot of noise i the file system. We should really keep the docs purely online so we control it and are able to change it.
The need is interesting though so we should discuss how to deliver a little more help about the file structure.
I don't like storing any kind of readme or manifest in the file system. How about storing a web link/URL/shortcut to the relevant online documentation page? We could enhance the documentation pages with a section called "Files Produced by this Process" or "Output File Listing".
Just to clarify, they were simply asking for a shortcut to the help documentation (not a readme). I don't like the idea of cluttering up the project file system with these hyperlinks. I do like the suggestion of producing a help file. I made one at http://gcd.riverscapes.xyz/Help/Concepts/projects/files.md. I will populate this information there.
https://github.com/Riverscapes/gcd/blob/master/docs/Help/Concepts/project/files.md
