Android Examples

[louwers]

This discussion is a bit of a brainstorm how we can create examples that stand the test of time.

I am afraid that if we include a bunch of source code in Markdown files that is neither built nor tested, it will get out of date quickly.

1. There should be CI that builds and tests the example app.
2. Source code should be referenced instead of copy pasted into Markdown files. Example
3. Dependabot should be set up to automatically create PRs to update dependencies.
4. There should be instructions how to add a new example.
5. To be decided: write documentation in in-source Markdown files or use a documentation generator and deploy.

[louwers]

Since we already have MapboxGLAndroidSDKTestApp which is very well tested, it may make sense to use the examples from this app.

A great benefit here is that this app is built and tested on CI.

A downside is that some features of these app are really more for developers of the SDK than for end-users.

We also probably don't want to say "here go check out this source code" since often an example requires more than just the source code. E.g. pulling some data from somewhere. Writing explanations about concepts and APIs involved. Etc.

[birkskyum]

Do we include source code in markdown files now? And if so - where?

[louwers]

We started to do this for the Android examples. https://github.com/maplibre/maplibre-native/blob/main/docs/mdbook/src/android/getting-started-guide.md

Maybe we can use literate programming instead: https://github.com/jillesvangurp/kotlin4example

[louwers]

Issue from @fynngodau who would like to work on this: maplibre/maplibre-plugins-android#27