documentation

[smnorris]

Some documentation is needed :grimacing:

[smnorris]

Documentation should include:

• general description of how the model works
• specific instructions/examples on how to edit input data
• specific instructions/examples of how to alter the model via the various sql files (particularly in 02_model/sql, the barriers*.sql and model.sql)
• specific instructions on how to run the model
• detailed output table descriptions/column descriptions (this can be automated via table/column comments)

[smnorris]

Docs folder and GH Actions tooling added to build the docs as per fwapg. Now need to update README files and add additional documentation.

[smnorris]

Some plain language documentation for the habitat models would be particularly useful.

With the habitat queries now split up by species it is easier to find the code/queries - but there is a lot duplication in each file, it is tricky to quickly see the differences.

[smnorris]

Documentation on how to run the scripts and of the various datasets is one piece. But we also need to:

• update/expand on existing methodology docs
• add some use case scenarios

Re use case scenarios, one possible (non fish passage specific) scenario is how to extract road/stream crossings from the provincial distribution for a given study area, meeting criteria for a hypothetical project for inspection/prioritization of new road stream crossings (from a given date) for compliance and enforcement inspection

[smnorris]

Documentation of tables/columns in the output habitat model is also required