Skip to content

Add guidance on when to use articles over vignettes#197

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/summarize-vignettes-article
Draft

Add guidance on when to use articles over vignettes#197
Copilot wants to merge 4 commits intomainfrom
copilot/summarize-vignettes-article

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 30, 2026

Extends the "Vignettes vs Articles" section with specific use cases for choosing articles from the R Packages book.

Changes

  • New subsection: "Additional considerations for choosing articles over vignettes" in code-repositories/package-structure.qmd
  • Four key scenarios where articles are preferred:
    • Code requiring authentication or external services (shouldn't execute on CRAN)
    • Demonstrating integration with non-dependency packages
    • Graphics-heavy content that would exceed CRAN size limits
    • Trade-off: reduced accessibility for offline users
  • Citation: [@wickham2023rpkgs, Section 17.4.1] using existing bibliography entry

The addition provides actionable criteria for developers deciding between vignette and article placement.

Original prompt

This section details on the original issue you should resolve

<issue_title>summarize and link to https://r-pkgs.org/vignettes.html#sec-vignettes-article</issue_title>
<issue_description></issue_description>

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


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits January 30, 2026 03:25
Co-authored-by: d-morrison <2474437+d-morrison@users.noreply.github.com>
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] Summarize vignettes article from r-pkgs.org Add guidance on when to use articles over vignettes Jan 30, 2026
Copilot AI requested a review from d-morrison January 30, 2026 03:33
@github-actions
Copy link
Copy Markdown

PR Preview Action v1.8.1-1-g6f3a89d

QR code for preview link

🚀 View preview at
https://UCD-SERG.github.io/lab-manual/pr-preview/pr-197/

Built to branch gh-pages at 2026-01-30 09:47 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

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.

summarize and link to https://r-pkgs.org/vignettes.html#sec-vignettes-article

2 participants