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

Documentation update #15

Open
ryantibs opened this issue Feb 1, 2022 · 3 comments
Open

Documentation update #15

ryantibs opened this issue Feb 1, 2022 · 3 comments

Comments

@ryantibs
Copy link
Owner

ryantibs commented Feb 1, 2022

Now that @matteo-fontana @paolo-vergo and team are planning to add a bunch of new functionality, we should:

  • update the authors in the DESCRIPTION to include the new folks who contribute code
  • update the README to include the new folks as well, as well as the new papers whose methods are reflected in the code
  • move all the documentation over to pkgdown/github docs. This (in my opinion) is way more readable and nice than the "old style" pdf documentation file.
  • assuming we do the last one, we should also move all the examples over to vignettes in the pkgdown site. Again, this (in my opinion) is a way nicer way to see examples of how to use the package.
@ryantibs
Copy link
Owner Author

@paolo-vergo I don't know how busy you are before you graduate (you may be very busy!) so don't feel pressured of course 🙂, but just in case you have free cycles and are interested, I think it would be great to move all the examples over to vignettes in the pkgdown/github docs site. They're much more accessible and readable that way.

(Just as an example of another project where we did that recently: https://cmu-delphi.github.io/epiprocess/, but you can find many more examples and tutorials on the web I'm sure.)

@paolo-vergo
Copy link
Contributor

Hi @ryantibs! In fact I am quite busy and I cannot really make promises. In any case I'll see if I can work on it.

@ryantibs
Copy link
Owner Author

Understood completely. Thanks for considering it, and no problem if you don't get to it.

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

No branches or pull requests

2 participants