mattermost / mattermost/react-native-emm

Android documentation incorrect / incomplete

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
18
Forks
7
Avg merge
1h 52m
Merged PRs (30d)
1

Description

I encountered two documentation issues when prototyping this package on a freshly-created RN project:

  1. As the native module is written in Kotlin, Kotlin needs to be added to the RN project. The documentation should instruct or link to instructions how to add it.
  2. The example app_restriction.xml does not work, as it seems to require the title and description to be references instead of direct strings. Also the 'see example' link is broken.
android/app/src/main/res/xml/app_restrictions.xml:4: AAPT: error: 'Test string description' is incompatible with attribute description (attr) reference.

Thanks for your work!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Android setup documentation and the example app_restrictions.xml mentioned in the report. Verify the Kotlin setup guidance, the title and description attributes, and the broken “see example” link. Done means the documentation explains adding Kotlin, the XML example uses valid references, and the link works.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, kotlin, react-native
Domain
documentation, mobile
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.