r-lib / R6

Encapsulated object-oriented programming for R
https://R6.r-lib.org
Other
403 stars 56 forks source link

edits to README and vignettes #239

Closed IndrajeetPatil closed 2 years ago

IndrajeetPatil commented 2 years ago
wch commented 2 years ago

While you're working on this, can you do one more thing? When I run pkgdown::build_site() locally, it complains with the following:

Warning message:
Missing images in 'README.md': 'articles/logo.png'
ℹ pkgdown can only use images in 'man/figures' and 'vignettes' 

And the resulting index.html has a broken image reference.

So I think that file needs to be moved to a different directory?

IndrajeetPatil commented 2 years ago

I think this is unexpected behavior on {pkgdown}'s part, and this PR might fix this issue.

So maybe we should wait for it to be merged and if the issue still persists, then we can have a look at the alternative solutions?

wch commented 2 years ago

I think this is unexpected behavior on {pkgdown}'s part, and this PR might fix this issue.

So maybe we should wait for it to be merged and if the issue still persists, then we can have a look at the alternative solutions?

Yes, I think it's a good idea to wait. Hopefully the issue will be addressed and no more changes will be needed. Thanks!

wch commented 2 years ago

@schloerke has informed me that the image does indeed need to be in /man/figures. Can you just change the reference in README.md to point to /man/figures/logo.png? There's already a copy of the same image there.

IndrajeetPatil commented 2 years ago

an you just change the reference in README.md to point to /man/figures/logo.png?

Done. Please check if this is what you had in mind.

wch commented 2 years ago

It's still behaving strangely when I build locally, but I'll merge and see how it goes.

wch commented 2 years ago

I merged it and now I'm getting a number of different errors when I run build_site(). I'll have to take a look at this later.

schloerke commented 2 years ago

@wch I'll fix the build_site() issues in #244