Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Create section for building pkgdown site in Writing Vignettes (focus on troubleshooting to build) #374

Open
4 tasks
bms63 opened this issue Mar 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@bms63
Copy link
Collaborator

bms63 commented Mar 8, 2024

Please select a category the issue is focused on?

Developer Guides

Let us know where something needs a refresh or put your idea here!

@pharmaverse/admiral

Hi all, Can everyone share some of their troubleshooting tips here around building the website. This seemed to be a pain point for new devs coming onto admiralpeds

I'd also like to provide new developers with some helpful guidance on some of the basics of the pkgdown site. This can just be pointing out the existence of the _pkgdown.yml file and linking the pkgdown guidance site anything we do that deviates from standard practice (website versions, pointing out existence of dev site, version bumps, etc)

Definition of Done

  • Change title of Writing Vignettes to Vignettes and Website
  • Create section specific to pkgdown website
  • Write generic pointers for working with pkgdown
  • Create subsection for troubleshooting tips for building website (big one!)
@bms63 bms63 added the documentation Improvements or additions to documentation label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant