Skip to content

update top-level docs - #263

Merged
aappling-usgs merged 1 commit into
mainfrom
top-docs
Oct 13, 2026
Merged

aappling-usgs merged 1 commit into
mainfrom
top-docs

Conversation

@aappling-usgs

Copy link
Copy Markdown
Collaborator

This PR updates several top-level docs, primarily for the sake of tidiness and modernity:

  • Switch recommended PAT handling from Sys.setenv to gitcreds functions. I did some experimenting and suspect gitcreds isn't even necessary for all these public repos, but I'm keeping it in because they are necessary for devtools::build_readme() (as now noted in dev.R) and I'm not sure they're NOT necessary for some users; in particular, we still don't have a straightforward installation figured out for Greg, though he found a workaround.
  • Add vignette links to ?loadflex and README.md
  • Use "_PACKAGE" correctly in loadflex.R, which causes pkgdown to move that documentation from man/loadflex.Rd to the now more standard man/loadflex-package.Rd
  • Move startupMessage contents into ?loadflex, because it feels less valuable and more obnoxious these days
  • Use standard, pkgdown-expected header format in NEWS (e.g., # Version 1.9.3)

@github-actions

Copy link
Copy Markdown

📖 pkgdown preview for this PR: https://doi-usgs.github.io/loadflex/preview/pr263/

@gfkltn gfkltn left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Admin review completed. No issues found.

@aappling-usgs
aappling-usgs merged commit 13ae859 into main Oct 13, 2026
1 check passed
github-actions Bot pushed a commit that referenced this pull request Oct 13, 2026
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