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

Docs overhaul #431

Open
wants to merge 13 commits into
base: dev
Choose a base branch
from
Open

Docs overhaul #431

wants to merge 13 commits into from

Conversation

dsweber2
Copy link
Contributor

Checklist

Please:

  • Make sure this PR is against "dev", not "main".
  • Request a review from one of the current epipredict main reviewers:
    dajmcdon.
  • Make sure to bump the version number in DESCRIPTION and NEWS.md.
    Always increment the patch version number (the third number), unless you are
    making a release PR from dev to main, in which case increment the minor
    version number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    0.7.2, then write your changes under the 0.8 heading).
  • Consider pinning the epiprocess version in the DESCRIPTION file if
    • You anticipate breaking changes in epiprocess soon
    • You want to co-develop features in epipredict and epiprocess

Change explanations for reviewer

Reviewing this should probably wait for #430 to merge

Draft ready for review:

  • Landing Page
  • Getting Started
  • Customized Forecasters
  • Reference
    • Using the add/update/remove and adjust functions
    • Smooth Quantile regression
  • preprocessing and models examples
  • backtesting forecasters

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

@dsweber2 dsweber2 requested a review from dajmcdon as a code owner January 23, 2025 20:59
@dajmcdon
Copy link
Contributor

/preview-docs

@dsweber2
Copy link
Contributor Author

/preview-docs

Copy link

github-actions bot commented Jan 23, 2025

@dshemetov
Copy link
Contributor

dshemetov commented Jan 23, 2025

Our setup is generating docs in dev/, so the link is off, this works:
https://6792d4953137ef0ce0547a4f--epipredict.netlify.app/dev/

Also FYI: the bot edits its own comment for links. Each preview is a separate link and the links stick around for like 90 days. You can see the previous links in the comment edit history.

Edit: this has been fixed on main so is no longer necessary

@dsweber2 dsweber2 force-pushed the docsDraft branch 2 times, most recently from a386493 to a30b035 Compare January 24, 2025 20:42
@dsweber2
Copy link
Contributor Author

/preview-docs

@dsweber2
Copy link
Contributor Author

/preview-docs

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

Successfully merging this pull request may close these issues.

3 participants