Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document case studies to guide interpretation of SARS-CoV-2 evolution based on Nextstrain analyses #632

Open
2 tasks
huddlej opened this issue May 12, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@huddlej
Copy link
Contributor

huddlej commented May 12, 2021

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

  • Drop the current unlinked reference to case studies from the tutorial
  • Curate and link out to some appropriate case studies from the tutorial index
@huddlej huddlej added enhancement New feature or request documentation Improvements or additions to documentation labels May 12, 2021
huddlej added a commit that referenced this issue May 12, 2021
Adds links to configuration reference docs and also cleans up the
tutorial listing in the README and the main tutorial index.

Relates to #632
huddlej added a commit that referenced this issue May 12, 2021
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/
@sidneymbell
Copy link
Collaborator

sidneymbell commented May 14, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants