debugging names docs

README.md

@@ -156,7 +156,7 @@ There are two public buckets:
 
 I would have loved to use PMTiles; they are a brilliant idea for serverless map hosting!
 
-Unfortunately, on Cloudflare, range requests in 90 GB files have terrible latency, and on AWS, the egress costs can be prohibitive.
+Unfortunately, on Cloudflare, range requests in 90 GB files have terrible latency, and on AWS, the data transfer costs can be prohibitive.
 
 Of course, with normal usage, you might fall within cloud vendor's free tier, but the internet is full of stories about people receiving surprise bills from AWS, sometimes amounting to thousands of dollars. It only takes one bad crawling bot getting stuck in a loop on your website to trigger such a bill.
 

docs/debugging_names.md

@@ -0,0 +1,41 @@
+# Debugging international names
+
+If there is an issue about international names not being displayed correctly, first, we need to find one specific example item and check at which stage does the problem appear.
+
+
+
+OpenFreeMap map data is created by the following stack:
+
+**OpenStreetMap data ➔ OpenMapTiles specification ➔ Planetiler**
+
+
+
+1. To debug OpenStreetMap data, go to OpenStreetMap.org and search for the query string. For example "Iwate Prefecture" gives these results: [nominatim](https://nominatim.openstreetmap.org/ui/details.html?osmtype=R&osmid=3792412&class=boundary) and [openstreetmap](https://www.openstreetmap.org/relation/3792412)
+
+<img src="assets/osm.png" alt="image-20240929124052402" style="zoom:50%;" />
+
+
+
+2. Then we need to check what the data is in the generated vector tiles. The best way to do this is to go to [Maputnik editor](https://maputnik.github.io/editor?style=https://tiles.openfreemap.org/styles/bright) and select View / Inspect.
+   <img src="assets/inspect.png" alt="image-20240929124615601" style="zoom:50%;" />
+
+3. Then you can search for the little red dot matching your label and make a screenshot.<img src="assets/maputnik.png" alt="maputnik" style="zoom:50%;" />
+
+
+
+Now we can compare where the naming problem is coming from.
+
+
+
+## Next steps
+
+It'd be nice to compare with other OpenMapTiles implementations like [tilemaker](https://github.com/systemed/tilemaker) or the [OpenMapTiles reference](https://github.com/openmaptiles/openmaptiles). I don't have full planet datasets from these implementations currently, so if someone is willing to run one it'd be a great contribution.
+
+
+
+
+
+
+
+
+

lint.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-
+set -e
 
 node_modules/.bin/prettier -w "**/*.md"