Commit e4b03ee
authored
docs(articles): bring the pkgdown articles onto the family template (#423)
* docs(articles): bring the pkgdown articles onto the family template
Every article is a landing page from search or a shared link, and almost none
said who wrote the package or how to cite it: across the 11 SDV R packages, 43
of 47 articles had no author/contributor footer and 44 had no citation block.
Adds only what each article was missing -- conformant headers and footers are
untouched, so this is a backfill rather than a rewrite:
* author line with X/GitHub follow badges, built from DESCRIPTION rather than
hand-listed, so authors and contributors stay in sync with the package;
* description, lifted from the article's own opening prose. Articles with no
prose to lift (parameter tables, pure code walk-throughs) deliberately get
none -- filler reads worse than absent, because pkgdown prints it under the
title on the article index and search engines lift it;
* opengraph image + twitter summary_large_image card pointing at the package's
own social card;
* the closing Our Authors / Contributors / Citation / Related block.
The twitter creator is per package, not uniformly @saiemgilani: cfbfastR has
its own handle, sportyR is @sportyR_pkg, and articles written by a specific
contributor keep that contributor's handle.
* docs(articles): hand-write the descriptions, track hoopR's parameter vignette
The auto-extracted opening sentence was serviceable but off-register. The
descriptions already in this family are one-liners with `<code>` markup naming
the functions the article actually uses, and pkgdown prints them under the
title on the article index. These were written after reading each article, so
they say what the piece does rather than however it happened to open.
hoopR's `vignettes/parameter-descriptions.Rmd` was listed in
`vignettes/.gitignore`, so it was never tracked -- edits to it looked applied
and silently never reached a commit. wehoop tracks its equivalent, so hoopR was
the odd one out. Removed from the ignore list and committed.
* docs(articles): fix the GitHub handles and BibTeX from the bot review
The GitHub follow badges reused each person's X handle. Those are different
namespaces, and 20 of 28 badge URLs returned 404 -- Tan Ho is @_TanHo on X but
tanho63 on GitHub, Ross Drucker is @rossdrucker9 and rossdrucker, Eric Hess is
@arbitanalytics and ehess. Both handles are now harvested from the packages'
own READMEs, which list them side by side, and the GitHub badge is omitted
where no handle is evidenced rather than guessed.
Guessing was tried and rejected: `github.com/RobertFrey` and
`github.com/BillyFryer` both resolve, but the handles baseballr and hoopR
actually link are `robert-frey` and `billyfryer`. A 200 proves a profile
exists, not that it belongs to the right person. Every handle now in the
articles was checked to resolve.
Also from the review:
* BibTeX author lists joined names with commas. BibTeX wants ` and `; with
commas a parser reads two people as one "Surname, Given".
* Where the package ships `inst/CITATION`, its title and year are used instead
of a generated title and a hard-coded 2026.
* "BibTex" -> "BibTeX".
* Contributors now get the same X + GitHub badge pair as authors.
* sportyR's vignette rendered both a hand-written `Author` section and the
generated `Our Authors` one; the superseded section is removed.
* cfbplotR: `man/cfbplotR-package.Rd` still named the previous maintainer.
roxygenise() cannot run in this checkout (pre-existing `logo_ref` load
failure), so the one derived line is synced to DESCRIPTION by hand.
* cfbplotR tutorial: "we can being to use" -> "we can begin to use".1 parent f798bff commit e4b03ee
4 files changed
Lines changed: 171 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
6 | 13 | | |
7 | 14 | | |
8 | 15 | | |
| |||
65 | 72 | | |
66 | 73 | | |
67 | 74 | | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
6 | 13 | | |
7 | 14 | | |
8 | 15 | | |
| |||
117 | 124 | | |
118 | 125 | | |
119 | 126 | | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
6 | 13 | | |
7 | 14 | | |
8 | 15 | | |
| |||
175 | 182 | | |
176 | 183 | | |
177 | 184 | | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
0 commit comments