pebble-dev / pebble-dev/developer.rebble.io
PebbleKit Android 2 documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
Current Android page still points to the old legacy version: https://developer.rebble.io/guides/communication/using-pebblekit-android/ . V2 is already out (and I plan to promote it to 1.0 sometime soon): https://github.com/pebble-dev/PebbleKitAndroid2
However, I'm not sure how to best approach updating the documentation. Github page of the PebbleKitAndroid2 already has pretty extensive documentation. Copying it to here would mean maintaining it twice. Do we just link it?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the current using-pebblekit-android documentation page and compare it with the documentation in the linked PebbleKitAndroid2 repository. Clarify whether this site should link to or duplicate the V2 documentation, then update the page so it directs users to the current version and the chosen documentation source is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100