Riverscapes Documentation

The Riverscapes Consortium (RC) publishes documentation for our tools, methods, and standards using several webites, including this one. These websites are all produced using Docusaurus, software that converts Markdown files into an interactive web site. The following sections provide information on how we use Docusaurus:

📄️Docusaurus

The Riverscapes Consortium uses the free and popular Docusaurus software to publish documentation websites. Below you will find information about how to work with Docusaurus, add content and even how to build a new site from scratch.

📄️Tool Web Sites

Many riverscapes tools (pieces of software) are documented using their own web site, for example:

📄️Tool Report Cards

Riverscapes software are accompanied by report cards that capture the status of the tool/script/model/code. The goal is to provide a quick reference for consumers of the software to gain an understanding of the tool, how they can use it and set expectations around its quality. The report cards provide:

📄️Source Code

Riverscapes tools are public and intended to be used by a broad variety of users. Therefore it is vital that the source code is logically organized and well documented.