badges show on docs.ropensci.org for some pkgs

[dpprdan]

For some packages, e.g. opencage, the badges in the README.md don't show on https://docs.ropensci.org/opencage/ (or only the one for peer-review in the sidebar).

Other examples are:

• gert
• awardFindR
• cffr
• gitignore

I (vaguely) suspect the <!-- badges: start --> comments to be the culprit as that seems to be the common denominator of the repos above.

[jeroen]

I think this is intended? We only show the software review badge now in the docs page: https://github.com/ropensci-org/rotemplate/issues/95

[maelle]

yes, it's a choice in pkgdown to not show badges on production websites, and we re-add the software review badge.

[dpprdan]

That's also great, but then it is inconsistent, because there are badges (in the main page, not the sidebar) on e.g.:

• bikedata
• codemetar
• bomrang
• crul
• pdftools

pkgdown only filters out the <!-- badges --> block then, I assume. (I guess, we could add a note to use the comments to devguide here?)

All in all not a big issue, though, so we can close this, IMO.

[maelle]

No, you're right, its annoying. One of these days I should probably do a round and make PRs to fix a bunch of READMEs. :sweat_smile:

[dpprdan]

pkgdown only filters out the <!-- badges --> block then, I assume.

Uh, maybe not. Counterexample: rotl has badges, and a <!-- badges --> block.

[maelle]

https://pkgdown.r-lib.org/reference/build_home.html#dev-badges

[dpprdan]

pkgdown.r-lib.org/reference/build_home.html#dev-badges

I think rotl passes those requirements (I read them as "or" reqs). Maybe they show up because the badges block comes before the title?

[maelle]

it might be https://github.com/r-lib/pkgdown/issues/2060

[maelle]

For info https://github.com/r-lib/pkgdown/pull/2220 :slightly_smiling_face: