search

maplibre / maplibre-style-spec

MapLibre Style Specification & Utilities
https://maplibre.org/maplibre-style-spec/
Other
76 stars 62 forks source link

Documentation for `image` source has minor typo to the radar GIF asset. #658

Closed roblabs closed 4 months ago

roblabs commented 4 months ago

Describe the bug Documentation for image source has minor typo to the radar GIF asset. This makes the copy/paste feature of the documentation useless. Fix for minor typo at https://github.com/maplibre/maplibre-style-spec/blob/1ebaa5a365df1502f2f99f5001697ff9409d3dfc/build/generate-docs.ts#L410

Additional context This fix will allow those trying to add image sources to be able to use a real image.

To Reproduce Steps to reproduce the behavior:

  1. Go to https://maplibre.org/maplibre-style-spec/sources/#image

  2. URL to radar GIF gives a 404; a minor typo in the path

    `404`:  https://maplibre.org/maplibre-gl-js-docs/assets/radar.gif
works:  https://maplibre.org/maplibre-gl-js/docs/assets/radar.gif
                                          ^^^

Expected behavior URLs to real MapLibre assets should work. If the example pointed to something arbitrary, E. G., https://example.com/radar.gif, we wouldn't fix.

Screenshots

roblabs commented 4 months ago

I would submit a PR, for this easy typo fix, but I can't get the npm run mkdocs to run successfully.

HarelM commented 4 months ago

Submit a PR, the CI will run the relevant check. I'll merge this.

HarelM commented 4 months ago

Fixed by #659