search

openmobilehub / android-omh-auth

Apache License 2.0
4 stars 1 forks source link

Documentation Update Required for Facebook App Setup Instructions #49

Open dzuluaga opened 5 months ago

dzuluaga commented 5 months ago

The current documentation for setting up the Facebook integration within the android-omh-auth project contains outdated instructions regarding navigating the Facebook App dashboard. The step mentioned as "Go to the App Settings -> Basic" does not align with the current Facebook App dashboard interface, leading to confusion during setup.

Steps to Reproduce

  1. Navigate to the android-omh-auth plugin-facebook setup instructions.
  2. Follow the setup instructions until you reach the step that says "Go to the App Settings -> Basic."

Expected Behavior

The documentation should guide the user through the current Facebook App dashboard interface accurately.

Actual Behavior

The mentioned step does not exist in the current Facebook App dashboard. Instead, after creating an app, the user must navigate through a different path to access the required settings.

Suggested Correction

Update the documentation to reflect the current steps needed to navigate the Facebook App dashboard. The updated steps should be:

  1. After creating your app, go to Use cases > Customize.
  2. Click on Go to quickstart.
  3. Select Android from the list of platforms.

This path reflects the current Facebook App dashboard's structure and will help users correctly configure their app for integration with the android-omh-auth project.

adamTrz commented 5 months ago

Hey @dzuluaga - thanks for pointing this out.

We will be working on unifying the documentation for all the providers. For the time being we would like to shorten up our documentation and point users to official guidelines for all the providers.

Facebook SDK docs (and other ones as well) can change rapidly and it can be hard to maintain 100% compatibility with them. What do you say that instead of copy-pasting the docs once in a while we just link users to official revised steps where they be guided how to integrate providers? We will shorten up our Readme's and point to the official docs that will always be up-to-date therefore mitigating any potential confusion :)

dzuluaga commented 5 months ago

Thanks @adamTrz for the update! I completely agree with the approach of linking to the official documentation to ensure our guidance remains current without the heavy maintenance.

Just to clarify, my suggestion was not to replicate the entire content from the Facebook steps. Rather, it would be helpful if we could provide specific guidance in our documentation. For instance, between steps 5 and 6 of the Facebook guide available here: FB Guide Link, it might be useful to direct users explicitly to the Android Quickstart under 'Use cases > Customize.' This could include a direct link to 'Go to Quickstart,' where they can then select Android from the platform list.

This small addition could help users navigate the integration process more smoothly and ensure they're accessing the most relevant information directly.

Thanks again for considering this!