Skip to content

docs: stop describing an embedded viewer - #2

Open
NivGreenstein wants to merge 1 commit into
masterfrom
feat/remove-viewer
Open

docs: stop describing an embedded viewer#2
NivGreenstein wants to merge 1 commit into
masterfrom
feat/remove-viewer

Conversation

@NivGreenstein

@NivGreenstein NivGreenstein commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

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 — /viewer returns 404.

What changed

  • getting-started.md loses its "Shigola viewer" step. What replaces it is a check that the
    service 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.md drops the GET /viewer/ entry and the -tags noViewer note; the tag no
    longer exists. style.json is no longer described as "used by the embedded viewer".
  • ogc-api-tiles.md and about.md stop listing the viewer among the things that surprise
    people, and about.md's credits keep every word of their attribution to Tegola except the viewer,
    which this codebase no longer contains.
  • download.md drops the go 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
    /viewer 404s".
  • The 3.3 MB screenshot of the viewer rendering Bonn is deleted.

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 not
satisfy the ticket's "noted as a breaking dashboard change" wording; see the note on MAPCO-11482.

Verification

npm run build passes — the real check here, since broken links and anchors throw. Run after
npm run clear and a cache wipe, given a file was deleted.

One repair beyond the removal: reordering getting-started.md had left a parenthetical whose
antecedent 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-viewer rather than docs/… to pair with the server branch by name; the
commit itself is docs:.

🤖 Generated with Claude Code

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant