Skip to content

First pass at making "Getting Started" guide better #350

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

Closed
brookslogan opened this issue Jul 25, 2023 · 3 comments · Fixed by #538
Closed

First pass at making "Getting Started" guide better #350

brookslogan opened this issue Jul 25, 2023 · 3 comments · Fixed by #538
Assignees
Labels
documentation Improvements or additions to documentation P1 medium priority

Comments

@brookslogan
Copy link
Contributor

Currently, "Getting Started" has installation instructions + a bunch of stuff on getting things into epi_df format + some plotting + nothing on other features of the package.

Suggestion:

  • Migrate the epi_df stuff to another vignette or combine it with another vignette.
  • Have Getting Started be installation instructions + pointers to various function reference pages and/or vignettes / the tooling book.

Or is there a way to just eliminate the Getting Started guide and just have the landing page serve that purpose?

@brookslogan brookslogan added documentation Improvements or additions to documentation P1 medium priority labels Jul 25, 2023
@nmdefries
Copy link
Contributor

nmdefries commented Oct 25, 2023

Open-ended

  • Landing page = installation + very basic usage
  • Getting started = medium-complexity use? quick start guide? Description of what you might want to do with links to relevant vignettes?

@dshemetov
Copy link
Contributor

dshemetov commented Oct 25, 2023

  • Attributions on the Getting Started page are a little awkward
  • No epi_archive examples
  • No discussion of the benefits of using an epi_df, would like to see a plot with epi_df
  • "Some details on metadata" and "Using additional key columns in epi_df" could likely move to another reference page

@brookslogan brookslogan changed the title Consider making "Getting Started" guide higher-level First pass at making "Getting Started" guide higher-level Oct 25, 2023
@brookslogan brookslogan changed the title First pass at making "Getting Started" guide higher-level First pass at making "Getting Started" guide better Oct 25, 2023
@dsweber2
Copy link
Contributor

Can we demo "easier" data sets than Covid cases (where forecasting is more tractable) or provide better context about performance

From a bullet point on an OKR, probably a good way to make this concrete

@brookslogan brookslogan self-assigned this Dec 4, 2023
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 P1 medium priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants