Skip to content

website landing page is jank #117

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
6 tasks done
dsweber2 opened this issue May 31, 2023 · 2 comments
Closed
6 tasks done

website landing page is jank #117

dsweber2 opened this issue May 31, 2023 · 2 comments
Assignees
Labels
P0 Top priority

Comments

@dsweber2
Copy link
Contributor

dsweber2 commented May 31, 2023

This needs to be updated: https://cmu-delphi.github.io/epidatr/

  • make a unique landing page for the website that is distinct from the github
  • documentation link out
  • both notes to changelog
  • basic usage example
  • get started: epidatr is a bit redundant, move the core here and edit the output to include results from a functional api key
  • codecov badge?
@dsweber2 dsweber2 added the P0 Top priority label May 31, 2023
@dshemetov dshemetov self-assigned this May 31, 2023
@dsweber2
Copy link
Contributor Author

\dontrun results in examples that look like this

if (FALSE) {
fluview_meta() %>% fetch()
}

I would consider this rather jank, but if its the only way to get roxygen to not run the code, then that's that. It would generally be good to have example results in the examples though.ff

@dshemetov
Copy link
Contributor

dshemetov commented Jul 14, 2023

That does look bad. We could cut those examples from the function documentation and replace them with a link to examples vignette.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 Top priority
Projects
None yet
Development

No branches or pull requests

2 participants