You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description
Instead of referring to documentation that doesn't exist yet (which doesn't really help users), we should link out to some actual case studies in the tutorial. These do not necessarily have to be our content, although we probably have some good examples in our old narratives.
Documents all available configuration parameters in a single file,
following the general format of JSON Schema [1] so we can eventually
encode this information in the schema and autogenerate docs from that
file, if we choose.
Adds links to this new documentation from both the README and the
tutorial index file. As part of these edits, also cleans up the README
and index file tables of contents.
Relates to #632
[1] https://json-schema.org/
Context
Our current ncov tutorial lists an unlinked item for "case studies" and states that these are "coming soon!". These docs were written nearly a year ago and the case studies do not exist.
Description
Instead of referring to documentation that doesn't exist yet (which doesn't really help users), we should link out to some actual case studies in the tutorial. These do not necessarily have to be our content, although we probably have some good examples in our old narratives.
Examples
Possible solution
The text was updated successfully, but these errors were encountered: