Skip to content

Update PebbleKit Android section to V2#110

Open
matejdro wants to merge 2 commits into
pebble-dev:mainfrom
matejdro:pk-android
Open

Update PebbleKit Android section to V2#110
matejdro wants to merge 2 commits into
pebble-dev:mainfrom
matejdro:pk-android

Conversation

@matejdro
Copy link
Copy Markdown
Contributor

As discussed in #109, this includes the PK2 Android as a submodules and includes its readme, replacing the old outdated PebbleKit Android documentation.

Issues from this approach:

  • Overview does not get populated with the included headers
  • Images do not work

There is still https://developer.rebble.io/docs/pebblekit-android/, but it seems a bit involved to replace, so I have decided to leave it for now.

fixes #109

Signed-off-by: Matej Drobnic <matej@matejdro.com>
Signed-off-by: Matej Drobnic <matej@matejdro.com>
@jwise
Copy link
Copy Markdown
Contributor

jwise commented Apr 26, 2026

cc: @Sorixelle

@Sorixelle
Copy link
Copy Markdown
Member

I'm not super keen on doing this as a submodule. I suspect at some point, we'll want to do some Javadoc-based docs generation like what we do with the old PebbleKit Android stuff, so it's probably better to do this as a checkout during CI, and then copying files to where they need to go when building. Bonus points for some CI in the PKA2 repo to automatically build Javadocs and produce an artifact on releases - that's what I would like to work towards for the CI here, personally.

@matejdro
Copy link
Copy Markdown
Contributor Author

What if we just link to the Github page instead?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PebbleKit Android 2 documentation

3 participants