Incorrect Placement and Organization of Sections in Getting Started Guide

[dzuluaga]

Following our discussion yesterday on improving the organization and clarity of the Getting Started Guide, I have compiled a bug report outlining the necessary modifications. These changes aim to enhance the guide's structure and ensure a smooth developer onboarding experience. Please review the following adjustments:

1. Move the "OmhMapView" and "OmhMap" sections to the "Advanced Features" Wiki page: The sections "OmhMapView" and "OmhMap" are currently misplaced within the guide. To ensure a more logical flow of instructions, it is recommended to relocate these sections to the "Advanced Features" Wiki page. This change will prevent confusion and provide users with a clearer understanding of when to explore these advanced features.

2. Group gradle changes under a section called "Gradle Configuration & Dependencies": The guide lacks a dedicated section covering the necessary gradle configuration and dependencies. To address this, create a new section titled "Gradle Configuration & Dependencies" and include the following information:

   • Instructions for configuring the core plugin
   • OMH gradle dependencies and their declaration
   • Classpath dependencies and declaration for the Gradle secrets plugin to handle the API_KEY placeholder
   • Removal of the current API_KEY custom code, as the Gradle secrets plugin will now handle it

3. Group changes for the AndroidManifest.xml: Similar to the previous point, the guide requires a dedicated section for changes in the AndroidManifest.xml file. Create a new section titled "AndroidManifest.xml Changes" and provide instructions for adding the location permissions and the API_KEY placeholder.

4. Add a "Map to Your App" section: To guide users in integrating maps into their apps effectively, include a new section titled "Map to Your App" with the following steps:

   • Instructions for modifying the layout.xml file to incorporate the OMH Fragment
   • Introduction of the DemoApp Application class and instructions for declaring it in the AndroidManifest.xml using the android:name attribute
   • Guidance on running the app to observe the map
   • A note highlighting the usage of variants, allowing users to run the same app with different maps without changing any code. Additionally, showcase the option to generate separate builds per device to accommodate different map configurations.

5. Add a "Display Your Current Location on the Map" section: To further enhance the functionality of the integrated map, add a new section titled "Display Your Current Location on the Map" that includes the following steps:

   • Instructions for adding the GetCurrentLocation and moveCamera functions, enabling the display of the user's current location on the map
   • Guidance on running the app to see the user's current location accurately displayed on the map.

By implementing these adjustments, the Getting Started Guide will offer users a more coherent and organized approach to incorporating maps into their Android applications. It is critical to include these steps to ensure a smooth developer onboarding experience. Therefore, I kindly request your urgent attention to meet the acceptance criteria.

CC - @rquino @prestonlau

[hans-hamel]

Hello. This is in process of merging: https://github.com/openmobilehub/omh-maps/tree/refactor/readme

[hans-hamel]

Rewrite the sections in branch https://github.com/openmobilehub/omh-maps/tree/release/1.0