mapzen / documentation

Configuration files, tools, and content to build Mapzen's documentation
https://mapzen.com/documentation
MIT License
25 stars 22 forks source link

Add language codes topic to search help #315

Closed rmglennon closed 6 years ago

rmglennon commented 7 years ago

This adds a new file about language support to the published search help on mapzen.com.

cc @dianashk @missinglink

rmglennon commented 7 years ago

preview: https://precog.mapzen.com/mapzen/documentation/5a3fe3bfc9c3784afcfce651f5a10dd883a7d782/documentation/search/language-codes/

missinglink commented 7 years ago

looks good! we could optionally include some information about the geocoding (header part) of the response JSON.

eg:

{
  "geocoding": {
      ...
      "lang": {
        "name": "German",
        "iso6391": "de",
        "iso6393": "deu",
        "defaulted": false
      },
      ...
    },
...

we return information in this block about the language which the system decided to use, this is useful for users to debug responses.

the block should always be present and should always contain 4 keys:

missinglink commented 7 years ago

note that for the query above I used ?lang=de-ch which refers to Swiss German and the response was returned in 'High German' ie Deutsch.

rmglennon commented 7 years ago

thanks, @missinglink - I can add this content over in pelias-doc repository.