docs: stop describing an embedded viewer - #2
Open
NivGreenstein wants to merge 1 commit into
Open
Conversation
Shigola ships no viewer, so the pages that told people to open one are wrong. They now simply do not mention one. There is no stable release to upgrade from, so there is nobody a migration note would be addressed to, and documenting the absence of a feature only raises a question the reader did not arrive with. The getting-started walkthrough loses its "Shigola viewer" step. What replaces it is a check that the service is actually serving -- the landing page and the collections list -- and a pointer to the tutorials, which already show how to put the tiles on a map with MapLibre, OpenLayers or Mapbox GL. That is now the only way to see them. Also drops the `GET /viewer/` endpoint entry and its `-tags noViewer` note, the viewer row from the surprises tables in about and ogc-api-tiles, the `go generate`/npm step from the download page, and the 3.3 MB screenshot of the viewer rendering Bonn. The credits keep every word of their attribution to Tegola except the viewer itself, which this codebase no longer contains. One repair beyond the removal: the reorder in getting-started left a parenthetical whose antecedent had moved two paragraphs away, and which was never closed. It now sits with the sentence it belongs to. Pairs with MapColonies/shigola: the viewer removal there is what makes these pages wrong. MAPCO-11482 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
NivGreenstein
force-pushed
the
feat/remove-viewer
branch
from
August 25, 2026 19:10
cd55359 to
6fda221
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes MAPCO-11482 (docs half). Server half: MapColonies/shigola#6
Shigola no longer ships a viewer, so the pages telling people to open one are now wrong, not
merely out of date —
/viewerreturns 404.What changed
getting-started.mdloses its "Shigola viewer" step. What replaces it is a check that theservice is actually serving — the landing page and the collections list — plus a pointer to the
tutorials, which already show how to put the tiles on a map with MapLibre, OpenLayers or Mapbox
GL. That is now the only way to see them.
http-endpoints.mddrops theGET /viewer/entry and the-tags noViewernote; the tag nolonger exists.
style.jsonis no longer described as "used by the embedded viewer".ogc-api-tiles.mdandabout.mdstop listing the viewer among the things that surprisepeople, and
about.md's credits keep every word of their attribution to Tegola except the viewer,which this codebase no longer contains.
download.mddrops thego generate/ npm step. Nothing in the build needs node any more.support.md's "/returns JSON instead of the viewer" entry becomes "/returns JSON, and/viewer404s".No migration note
These pages simply stop mentioning a viewer, rather than announcing that one was removed. There is
no stable release to upgrade from, so there is nobody a "breaking change" note would be addressed
to — and documenting the absence of a feature only raises a question the reader did not arrive with.
That means the
shigola_viewer_*metric family goes unmentioned too. It deliberately does notsatisfy the ticket's "noted as a breaking dashboard change" wording; see the note on MAPCO-11482.
Verification
npm run buildpasses — the real check here, since broken links and anchors throw. Run afternpm run clearand a cache wipe, given a file was deleted.One repair beyond the removal: reordering
getting-started.mdhad left a parenthetical whoseantecedent moved two paragraphs away, and which was never closed (a pre-existing missing bracket).
It now sits with the sentence it belongs to.
Branch is
feat/remove-viewerrather thandocs/…to pair with the server branch by name; thecommit itself is
docs:.🤖 Generated with Claude Code