Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

PR Review Comments Addressed

Changes Made

  1. Removed unused preamble files (Comments #2740228225, #2740228416, #2740228612):

    • Deleted altdoc/preamble_man_qmd.yml
    • Deleted altdoc/preamble_vignettes_qmd.yml
    • Deleted altdoc/preamble_vignettes_rmd.yml

    These files are not needed by altdoc and were leftover from the initial setup.

  2. Fixed search exclude comment (Comment #2738982405):

    • Removed incorrect project.render: ["!preview/"] configuration
    • Added clarifying comment explaining that preview/ only exists on gh-pages branch (not in source)
    • Since preview/ is deployment-only, no search exclusion needed in Quarto config

Why These Changes

The preamble files were experimental configurations that altdoc doesn't actually use. Removing them simplifies the configuration.

The preview/ directory exclusion was attempting to exclude from rendering, not from search. Since preview/ only exists on the deployed gh-pages branch and never in the source repository, there's nothing to exclude in the Quarto config.

Remaining Comment

Comment #2740227350 asks why not use deploy steps from main branch. The answer is that main branch doesn't have the altdoc workflow yet - this PR IS the migration. Once merged, main will have these deploy steps.

Original prompt

This section details on the original issue you should resolve

<issue_title>try switching to altdoc</issue_title>
<issue_description>altdoc.etiennebacher.com</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 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 27, 2026 06:18
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] Switch to altdoc for better performance Switch from pkgdown to altdoc for documentation Jan 27, 2026
Copilot AI requested a review from d-morrison January 27, 2026 06:24
Copilot AI and others added 2 commits January 27, 2026 06:39
…tracking

Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.

Copilot AI and others added 2 commits January 27, 2026 06:51
…ores, mark man/ as generated

Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
@d-morrison
Copy link
Member

Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 27, 2026

@copilot fix https://github.com/UCD-SERG/rpt/actions/runs/21387306663/job/61566640641

Fixed in commit 04305cf. The workflow was missing the r-lib/actions/pr-fetch@v2 step needed for PR builds. This step fetches the PR branch changes before building the documentation. The workflow should now succeed.

Copy link
Member

@d-morrison d-morrison left a comment

Choose a reason for hiding this comment

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

…bility

Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 28, 2026

https://github.com/UCD-SERG/rpt/actions/runs/21431713017/job/61716764870 fix

Fixed in commit 0ab2a7b. The workflow failure was due to network timeout connecting to r2u.stat.illinois.edu. Replaced the custom r-ci bootstrap script with standard r-lib actions (setup-r@v2 and setup-r-dependencies@v2) which use Posit Public Package Manager for more reliable dependency installation.

_pkgdown.yml Outdated
Copy link
Member

Choose a reason for hiding this comment

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

can we recreate this structure using the quarto website framework? right now quarto_article.qmd doesn't seem to get included in the website

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added Articles section to the Quarto website sidebar in altdoc/quarto_website.yml. The configuration now includes $ALTDOC_ARTICLE_BLOCK which will automatically populate with articles from vignettes/articles/ directory (including quarto_article.qmd). This mirrors the pkgdown structure where articles were shown separately from vignettes.

Comment on lines 180 to 184
id: pkgdown-deploy
# recreate: true ensures the preview comment is always visible at the bottom
# of the PR by deleting the old comment and creating a new one.
# Alternative: Use append: false to update in place (may get hidden in long PRs)
recreate: true
Copy link
Member

Choose a reason for hiding this comment

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

why did we remove recreate: true?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The recreate: true parameter wasn't removed - it was never added to the altdoc workflow in the initial implementation. The pkgdown workflow originally had it (as seen in commit 2695bfe), but when creating the new altdoc workflow, I used append: true instead to ensure preview URL comments always appear at the newest end of the conversation (per feedback in an earlier comment). I can restore recreate: true if that's the preferred behavior.

Copy link
Member

Choose a reason for hiding this comment

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

I think you're confused about what append: true does; please double check

# Alternative: Use append: false to update in place (may get hidden in long PRs)
recreate: true
id: altdoc-deploy
append: true
Copy link
Member

Choose a reason for hiding this comment

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

why did we switch from recreate: true to append: true?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Switched to append: true to address earlier feedback requesting that comments not get buried in hidden items and always appear at the newest end of the conversation. With recreate: true, the comment gets updated in place which could get collapsed/hidden. With append: true, each deployment creates a new comment at the bottom. I can change back to recreate: true if you prefer the single-comment behavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected in commit 5521453. I misunderstood append: true - it appends text to the same comment (making it longer), not creates new comments. Changed to recreate: true which deletes the old comment and creates a new one at the bottom of the conversation, ensuring the preview URL is always visible and not buried in collapsed comments.

… update WORDLIST

Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Comment on lines 23 to 26
- section: $ALTDOC_VIGNETTE_BLOCK
- section: Articles
contents: $ALTDOC_ARTICLE_BLOCK
- section: $ALTDOC_MAN_BLOCK
Copy link
Member

Choose a reason for hiding this comment

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

this didn't work:

Image

condense these two sections into one, with two subsections "Get started" and "Advanced Topics", like we had in the old pkgdown site. quarto_article.qmd should go in the advanced topics section, like it was before

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in commit 5521453. The sidebar now has two separate top-level sections "Get started" and "Advanced Topics" instead of nesting them under "Articles", matching the pkgdown structure. The quarto_article.qmd will appear in the "Advanced Topics" section.

url: https://ucd-serg.github.io/rpt/
template:
bootstrap: 5
light-switch: yes
Copy link
Member

Choose a reason for hiding this comment

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

add dark mode to the new setup

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added in commit 5521453. Dark mode toggle now available with cosmo (light) and darkly (dark) themes.

development:
mode: auto
search:
exclude: preview/
Copy link
Member

Choose a reason for hiding this comment

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

make sure the preview subdirectory is blocked from search in the new setup

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in commit 5521453. Using project.render with "!preview/" pattern to exclude preview directory from rendering (Quarto doesn't support search.exclude property).

Copy link
Member

Choose a reason for hiding this comment

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

figure out why the codefactor badge isn't rendering in the PR preview:

Image

…lude, correct comment append behavior

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 Switch from pkgdown to altdoc for documentation using Quarto Migrate documentation from pkgdown to altdoc with Quarto backend Jan 28, 2026
@github-actions
Copy link
Contributor

📖 https://ucd-serg.github.io/rpt/preview/pr35
Preview documentation for this PR (at commit 84edca6)

render:
- "*.qmd"
- "*.md"
- "!preview/"
Copy link
Member

Choose a reason for hiding this comment

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

we want to block the preview/ folder from being searched, not rendered; look at what we did in the old pkgdown config

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in commit b098886. The preview/ directory only exists on the deployed gh-pages branch, not in the source repository, so no search exclusion is needed in the Quarto config. Removed the incorrect project.render exclusion and added a clarifying comment.

shell: Rscript {0}

- name: Deploy PR Preview
- name: Deploy to GitHub Pages
Copy link
Member

Choose a reason for hiding this comment

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

why not use the deploy steps from main?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The main branch doesn't have altdoc deployment yet - this PR is the migration from pkgdown to altdoc. Once this PR is merged, main will have these deployment steps. The custom script is needed for PR preview subdirectories which standard actions don't support.

d-morrison and others added 2 commits January 28, 2026 23:02
Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 29, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • accounts.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • android.clients.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • clients2.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • clientservices.googleapis.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • https://api.github.com/repos/UCD-SERG/ucd-serg.github.io/contents/.github/workflows
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)
  • optimizationguide-pa.googleapis.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • redirector.gvt1.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • safebrowsingohttpgateway.googleapis.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • update.googleapis.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)
  • www.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=10595 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.ZsOkuY --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,5876534069424691370,15573572233991565567,262144 --disable-features=PaintHolding --variations-seed-version --trace-process-track-uuid=3190708989122997041 (dns block)
    • Triggering command: /opt/google/chrome/chrome /usr/bin/google-chrome --headless --no-sandbox --disable-gpu --renderer-process-limit=1 --remote-debugging-port=9222 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

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.

try switching to altdoc

3 participants