documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Formatting of terminology

Open souperneon opened this issue 9 years ago • 2 comments

http://dev.mapzen.com/documentation/valhalla/terminology/

The bulleted list is a little hard to read. This is a good place to establish a standard way to do terminology lists and parameters (key value pair lists). I suggest we make the term bold (easy) but ideally we put it in a table so it's super easy to scan and find stuff Examples: Shopify (https://docs.shopify.com/api/metafield) Mapbox (https://www.mapbox.com/developers/api/surface/#parameters)

souperneon avatar Oct 12 '15 21:10 souperneon

@souperneon For Search, I did something more like this: https://github.com/pelias/pelias-doc/blob/master/glossary.md

From this PR: https://github.com/pelias/pelias-doc/pull/47

The comment was to make these linkable. I think we might be able to do that with an H3?

rmglennon avatar Oct 12 '15 21:10 rmglennon

Yeah that's great. We should do that everywhere.

souperneon avatar Oct 12 '15 21:10 souperneon