Skip to content

Add multi-version pkgdown documentation with version dropdown#474

Merged
d-morrison merged 13 commits intomainfrom
copilot/adapt-pkgdown-setup
Jan 15, 2026
Merged

Add multi-version pkgdown documentation with version dropdown#474
d-morrison merged 13 commits intomainfrom
copilot/adapt-pkgdown-setup

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 13, 2026

Description

Implements multi-version pkgdown documentation based on serodynamics PR #173, enabling version navigation via dropdown menu and versioned documentation URLs.

Changes

Workflow

  • Added .github/workflows/docs.yaml with 4-job architecture:
    • docs: Builds site for PRs (preview), main branch, and version tags
    • multi-version-docs: Generates version dropdown using insightsengineering/r-pkgdown-multiversion@v3
    • upload-release-assets: Uploads pkgdown.zip to releases
    • cleanup-pr-preview: Removes PR previews on close
  • Removed .github/workflows/pkgdown.yaml (single-version workflow)

Configuration

  • Updated pkgdown/_pkgdown.yml: Added search: exclude: ['preview/']
  • Added .github/MULTI_VERSION_DOCS.md: Setup documentation and troubleshooting guide

Documentation

  • Updated NEWS.md: Added feature entry for multi-version documentation

Features

  • Version dropdown: main (dev), latest-tag (default landing page), and semver tags (v1.0.0, etc.)
  • PR previews at https://ucd-serg.github.io/serocalculator/preview/pr<number>/ with auto-cleanup
  • Version-specific URLs: https://ucd-serg.github.io/serocalculator/{version}/
  • Release assets: pkgdown.zip attached to each release

Checklist

  • The title of your PR should briefly describe the change.
  • Commit/merge messages to be included in NEWS.md should begin with -.
  • Code should follow the tidyverse style guide.
  • Documentation should use roxygen2, with Markdown syntax.
  • Contributions should include unit tests (using testthat). (N/A - workflow configuration)

For more information see Contributing.

Original prompt

adapt pkgdown setup from ucdavis/serodynamics#173


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 13, 2026 19:28
- Add new .github/workflows/docs.yaml with multi-version support
- Update pkgdown/_pkgdown.yml to exclude preview directories from search
- Add .github/MULTI_VERSION_DOCS.md documentation
- Remove old .github/workflows/pkgdown.yaml workflow
- Update NEWS.md with multi-version documentation feature

Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Copilot AI changed the title [WIP] Update pkgdown setup from ucdavis/serodynamics Add multi-version pkgdown documentation with version dropdown Jan 13, 2026
Copilot AI requested a review from d-morrison January 13, 2026 19:32
@d-morrison d-morrison marked this pull request as ready for review January 13, 2026 19:32
Copilot AI review requested due to automatic review settings January 13, 2026 19:32
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 13, 2026

📕 Preview documentation for this PR has been cleaned up.

github-actions Bot added a commit that referenced this pull request Jan 13, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

github-actions Bot added a commit that referenced this pull request Jan 14, 2026
github-actions Bot added a commit that referenced this pull request Jan 14, 2026
github-actions Bot added a commit that referenced this pull request Jan 15, 2026
github-actions Bot added a commit that referenced this pull request Jan 15, 2026
github-actions Bot added a commit that referenced this pull request Jan 15, 2026
@d-morrison d-morrison merged commit 7618791 into main Jan 15, 2026
18 of 19 checks passed
@d-morrison d-morrison deleted the copilot/adapt-pkgdown-setup branch January 15, 2026 07:01
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