For Mobile SDKs, Create a Documentation website or GH-Pages

[roblabs]

Starting a GitHub Project for a Documentation web site for GL Native docs (similar to maplibre/maplibre-gl-js-docs).

Examples of how it could be designed:

• MapLibre.org/docs/android
• MapLibre.org/docs/ios

or,

• docs.maplibre.org/mobile/ios
• etc.

or, it could simply be hosted on the branch gh-pages

• maplibre.github.io/maplibre-gl-native/ios
• maplibre.github.io/maplibre-gl-native/android

Tasks

• Review existing docs and rebrand for MapLibre
• Setup hosting (determine web site architecture, CNAME, GH-pages, etc)
• Update GitHub Actions to publish based on a release

---

Notes on making docs

Android

• GitHub Action

• make android-javadoc

iOS

• maplibre-gl-native/platform/ios/platform/ios/scripts/document.sh
• make idocument

[matkoniecz]

Would it also cover updating links in README - https://github.com/maplibre/maplibre-gl-native/tree/master/platform/android#getting-started ? Or is it a different documentation?

[mohand1993]

@petr-pokorny-1
isn't the documentation here https://docs.maptiler.com/maplibre-gl-native-android/ up-to-date?

[wipfli]

Oh nice we should build this :)

[wipfli]

I guess building the iOS docs only works on macos...

[wipfli]

This is completed now I think. Android API Docs are here https://maplibre.org/maplibre-gl-native/android/api/ and the iOS here https://maplibre.org/maplibre-gl-native/ios/api/

[mohand1993]

@wipfli Are there any plans to create a quickstart tutorial (e.g. anything similar to https://maplibre.org/maplibre-gl-js-docs/api/#quickstart)?

[wipfli]

Yes let's do that, can you help me setting something like this up? Could be something like a simple markdown document...

[mohand1993]

@wipfli I am afraid we cannot, as we are not that familiar with the library.
We kind of hoped we can find such tutorial that helps us adopting this maps solution in our apps, so we haven't started using the library yet.