Upgrades to documentation

[joewheaton]

Please update your documentation for Riverscapes Compliance as per here. I can see you and @wally-mac put a ton of effort into this. It is nice. Lets get it at least to riverscape compliance pending.

Things I noticed:

• Release and version missing
• No download of tool
• No link to source code or repo
• There is limited high-level "this is what the tool does". Front page is nice, but amigouous.
  Missing following from site content recommendations
• Release Notes
• Acknowledgements should be on separate page
• Source Code
• Citations
• Prerequisites

On your documentation, I am really NOT a fan of linear wizard driven tools and documentation (i.e. Step 1, Step 2). That makes sense for a tutorial, but seems hard for tools. I would at least:

• Provide a name in title for each step (e.g. instead of Step 1 use Step 1 - Project Housekeeping)

[tyler1218hatch]

@joewheaton I'll look into this soon. PNET is a tool that was really developed for a singular project. I'm happy to spend some time improving it and making it more flexible, as well as getting it Riverscapes Compliant.

[joewheaton]

There is no rush on this obviously... it just strikes me that a few hours sometime will help push this over the finish line. It is a nice little tool.

…

_____________________ Dr. Joseph M. Wheaton 435-554-1247 (direct) | http://www.joewheaton.org

On Thu, Feb 11, 2021 at 7:58 PM Tyler Hatch ***@***.***> wrote: @joewheaton <https://github.com/joewheaton> I'll look into this soon. PNET is a tool that was really developed for a singular project. I'm happy to spend some time improving it and making it more flexible, as well as getting it Riverscapes Compliant. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACKGAAI5ALOWRNZJGFVPW6TS6SKM7ANCNFSM4XPRZNJA> .