RS-Compliant Documentation of RIM tool.

[joewheaton]

Hi @kbartelt. Nice job getting this up. Thanks for posting it. I just wanted to put in a request to get this thing to be riverscapes-compliant or at least pending. To start, check out:

1. the documentation standards and in particular the source code documentation
2. and the tool web sites, which can be really simple.

I am reassigning this to @jtgilbert:
Should have:

• Landing page that is targeted either at consumers of RIM projects and/or people running tool
• Acknowledgements Page (funding, developers, etc.)
• Download / Soucecode / Tool links to GitHub and instructions
• RS-Compliance Report Card for ArcPy version, and soon for QRiS version
• Video included in Protocol Description (protocol should not be a how to specifying which tool, just what to do) #20
• Help Documentation for Tools by Version
• Technical References (for curators and developers) #19

If you have any questions of @philipbaileynar or I use the @philipbaileynar or @joewheaton MD syntax so we get notified, and post them here.

[joewheaton]

• Landing page that is targeted either at consumers of RIM projects and/or people running tool

https://rim.riverscapes.net/

• Acknowledgements Page (funding, developers, etc.)

https://rim.riverscapes.net/About/acknowledgements.html

• Download / Soucecode / Tool links to GitHub and instructions

https://rim.riverscapes.net/About/license.html

• RS-Compliance Report Card for ArcPy version, and soon for QRiS version

ArcPy version: https://rim.riverscapes.net/About/Status/Tool_ReportCard_0-1-00.html
QRiS too come.. @nick4rivers

• Video included in Protocol Description (protocol should not be a how to specifying which tool, just what to do)

Not yet... Only text and figures: https://rim.riverscapes.net/Documentation/Protocols/

• Help Documentation for Tools by Version

https://rim.riverscapes.net/Documentation/running/

• Technical References (for curators and developers)

Lacking.

[joewheaton]

I'm closing as I just got most of this over finish line. Created #19 and #20 for rainy day.