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

Improve welcome to the project pages #117

Closed
gvegayon opened this issue May 13, 2024 · 0 comments · Fixed by #118
Closed

Improve welcome to the project pages #117

gvegayon opened this issue May 13, 2024 · 0 comments · Fixed by #118
Assignees
Labels
development task documentation Improvements or additions to documentation

Comments

@gvegayon
Copy link
Member

Goal

The README.md and home page (sphinx) of the project need to be clearer. Particularly, it should state explicitly what the project is about, talk about pyrenew, and probably provide some examples for new users.

Context

TBA

Required features

  • List the project goals and description, linking the wastewater project.
  • REAMDME.md should be the same on the Sphinx website and the GitHub repo.
  • Show a toy model example (RtInfectionRenewalModel probably).
  • Add links to the existing tutorials.

Specifications

  • README.qmd file with all the content.
  • CI added to the website building, updating the index.html and README.md
@gvegayon gvegayon added documentation Improvements or additions to documentation development task labels May 13, 2024
@gvegayon gvegayon added this to the Sprint J milestone May 13, 2024
@gvegayon gvegayon self-assigned this May 13, 2024
@gvegayon gvegayon linked a pull request May 13, 2024 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development task documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant