OMH Documentation in GitHub

[rquino]

Describe the bug Opening just on log to address multiple documentation issues:

Issue 1 Description: OMH Maps SDK Description in Github

Steps to Reproduce:

1. The first paragraph doesn’t clearly explain the problem and solution. It is very vague and confusing: “The solution to seamlessly integrating maps across GMS and non-GMS devices. Our open-source Android SDK tackles the problem of device compatibility, allowing developers to use the same SDK without worrying about specific device requirements.”

Expected Result: Please rethink how to properly explain in steps the issue we are addressing and the solution we propose.

Actual Result: N/A

Severity: [Low - Easy workaround ] Workaround: Rewrite the intro text

Issue 2: Documentation

Description: OMH Core description in GitHub

Steps to Reproduce:

1. The first paragraph doesn’t clearly explain what is OMH. It’s very vague with a lot of text that doesn’t get to the point: ” OMH is an open-source Android SDK to make easily swap between GMS, HMS and our custom OHM services. It aims at creating low coupled, extensible SDK reducing the code boilerplate of switching between GMS, HMS, or any other service, and also provides a custom full open source alternative services switching automatically according to your configuration in the Gradle plugin giving the right outputs without overloading your APK with unnecessary libraries.”
2. Moreover, not sure if we need to reference HMS devices.
3. For someone new to this, the first question would be, what is this OMH for, and this text fails to explain that.

Expected Result: Please rewrite with an easier to understand description. Pay attention to grammar. Write from a non-tech perspective, trying to explain this in simple terms (marketable), while at the same time putting some technical details.

Actual Result: N/A

Severity: [Low - Easy workaround ] Workaround: Rewrite the intro text

Issue 3: Documentation

Description: Add OMH Core Plugin Documentation changes Steps to Reproduce: Issue 3.1. In Step 1, the text is not clear:
In the project's settings.gradle file in the dependencyResolutionManagement, then in the repositories the maven reference maven { url 'https://s01.oss.sonatype.org/content/groups/staging/' }

This paragraph has grammatical errors. The sequence of steps is not clear.

Issue 3.2. In step 4 in the same page: You can choose whatever name you want for the class, it is not mandatory to use DemoApp.

Don’t use ‘whatever’. Replace for something else like “any”.

Issue 3.3. Under ‘Configure the OMH Plugin”. In the text: To use the core plugin is required some.... We need to add ‘it’ so it reads: To use the core plugin, it is required some...

Issue 3.4. Under “Add the map into your app”, the following is displayed:

“The main interfaces that you will be interacting with are called OmhMap, OmhMapView and OmhLocation. It contains all your basic maps and location functions like displaying a marker, map gestures, getting current location and more”.

Please define exactly what is ‘more’. Can’t leave it vague to guess what are the other functions.

Expected Result: Please rewrite with easier text to understand steps. Actual Result: N/A

Severity: [Low - Easy workaround ] Workaround: Rewrite the intro text

@dzuluaga @prestonlau @itsme291

[dzuluaga]

@nelsonwilches and @hans-hamel - can you please take a look and address these issues? Thanks!

[hans-hamel]

Thanks for the feedback. Already updated the documentation in the branch https://github.com/openmobilehub/omh-maps/tree/release/1.0

[dzuluaga]

Done