Skip to content

feat: scaffold pkgdown site with GitHub Pages#41

Merged
bart-turczynski merged 1 commit into
mainfrom
feature/pkgdown-site
Jun 21, 2026
Merged

feat: scaffold pkgdown site with GitHub Pages#41
bart-turczynski merged 1 commit into
mainfrom
feature/pkgdown-site

Conversation

@bart-turczynski

Copy link
Copy Markdown
Owner

Summary

  • Adds _pkgdown.yml with Bootstrap 5 template and reference section grouped by topic (Parsing, Accessors, Joining, Cache management)
  • Adds .github/workflows/pkgdown.yaml to auto-build and deploy the site to GitHub Pages on every push to main
  • Updates DESCRIPTION URL field so the pkgdown site comes first (CRAN will pick this up as the primary link)
  • Adds pkgdown to Suggests

After merging

Enable GitHub Pages on the repo (Settings → Pages → Source: Deploy from branch gh-pages) if it isn't already on — the workflow will create/update the gh-pages branch automatically on first run.

Test plan

  • CI pkgdown workflow passes on this PR (runs on PRs targeting main but doesn't deploy)
  • After merge, confirm the pkgdown workflow runs successfully on main
  • Verify https://bart-turczynski.github.io/rurl/ is live and shows grouped reference section

Closes RURL-qvktzxdt

🤖 Generated with Claude Code

- Add _pkgdown.yml with bootstrap 5 template and reference grouped by
  topic (Parsing, Accessors, Joining, Cache management)
- Add .github/workflows/pkgdown.yaml to auto-deploy on push to main
- Update DESCRIPTION URL field to lead with the pkgdown site URL
- Add pkgdown to Suggests

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bart-turczynski bart-turczynski merged commit 4652318 into main Jun 21, 2026
7 checks passed
@bart-turczynski bart-turczynski deleted the feature/pkgdown-site branch June 21, 2026 18:15
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.

2 participants