Commit adeccf6
authored
docs: point contributors at geolibre-assets for images and demos (#1768)
* docs: point contributors at the geolibre-assets repo for binaries
Screenshots, GIFs, and sample datasets were being committed straight into
docs/assets, which permanently enlarges the clone for everyone since Git
history keeps them forever. Add a Documentation subsection directing
contributors to opengeos/geolibre-assets instead, with the repo-path to
assets.geolibre.app URL mapping, the per-directory conventions, the format
preferences, and the caveat that published paths are effectively permanent.
* Address CodeRabbit review feedback
- Spell out the hosting contract: geolibre-assets is a plain static host (any
file type), publishes from `main` via GitHub Pages under its single hostname
assets.geolibre.app, usually within a minute, with GitHub's 100 MB per-file
limit.
- Note that some existing pages point at other GeoLibre-operated hosts
(data.geolibre.app, files.opengeos.org); those URLs keep working and need no
rewriting, but new assets go to geolibre-assets since that is the one
contributors can open a PR against.
- State explicitly that the published assets.geolibre.app URL is the exception
to the "link to files outside docs/ with a full GitHub URL" rule above.
* Address Claude review feedback
- Align the asset-path table's pipe columns; all five rows are now the same
width. No pre-commit hook formats Markdown, so this would not have been
fixed automatically.
- Soften the closing sentence, which asserted a stricter invariant than the
repo satisfies: docs/assets/ also holds an orphaned geolibre-app.png that
nothing references. It now names the icon as the one live file and says an
unreferenced file there is a leftover, not a precedent.1 parent 475b37e commit adeccf6
1 file changed
Lines changed: 50 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
197 | 197 | | |
198 | 198 | | |
199 | 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 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
200 | 250 | | |
201 | 251 | | |
202 | 252 | | |
| |||
0 commit comments