In the light of recent developments (Mapzen shutting down), and some other suggestions by clients, we decided that our documentation requires a major overhaul.
A similar issue (detailing more urgent tasks) exists in CartoDB/docs/ repository.
Here are my initial thoughts on the subject:
Major Changes
"Creating App Token / License Key" is a lengthy paragraph with lots of images, I believe it warrants its own section
"Getting Started" is a useful section and I don't want to move it anywhere, but it needs to be a lot shorter, contain fewer paragraphs:
Registring license
Base Layer
Vector elements (with intro to datasources and layers, but no sample code for adding different kinds of elements, just a marker)
"Developer Guide to SDK Features" doesn't really mean anything as such, it's another huge section detailing many different features that, while useful, should be split into different sections
"Loading Map Data" should be renamed to "Data Sources", as that is the keyword when trying to add different layers to the map.
"SDK & Carto Tools" should be renamed to "CARTO Integrations", it's more intuitive. Perhaps design paragraphs like we have in our sample applications, i.e:
In the light of recent developments (Mapzen shutting down), and some other suggestions by clients, we decided that our documentation requires a major overhaul.
A similar issue (detailing more urgent tasks) exists in CartoDB/docs/ repository.
Here are my initial thoughts on the subject:
Major Changes
"Creating App Token / License Key" is a lengthy paragraph with lots of images, I believe it warrants its own section
"Getting Started" is a useful section and I don't want to move it anywhere, but it needs to be a lot shorter, contain fewer paragraphs:
"Developer Guide to SDK Features" doesn't really mean anything as such, it's another huge section detailing many different features that, while useful, should be split into different sections
"Loading Map Data" should be renamed to "Data Sources", as that is the keyword when trying to add different layers to the map.
"SDK & Carto Tools" should be renamed to "CARTO Integrations", it's more intuitive. Perhaps design paragraphs like we have in our sample applications, i.e:
Minor Changes
As a client pointed out, event listener logic needs to be cleanup, VectorElementEventListener not prominent enough: https://gis.stackexchange.com/questions/266557/cannot-override-onvectorelementclicked-from-mapeventlistener
Note in documentation that Swift projects require a bridging header. To configure a bridging header:
Fix links in documentation. Received a ticket that references a non-existant offline-map-packages directory (https://carto.com/docs/carto-engine/mobile-sdk/offline-maps/#offline-map-packages)
PackageManager.md
requires a better explanation of howstartPackageDownload("package-id")
and bounding box download works