atsign-foundation/at_widgets

docs: at_onboarding_flutter docs insufficiently clear for new users

Closed this issue · 4 comments

gkc commented

Which at_widget package you find issue with?

at_onboarding_flutter

On what platforms did you experience the issue?

Android

What version are you using?

Latest

What happened?

Customer @ralfeus encountered issues using the widget because

  • description of usages of the parameters to AtOnboarding.onboard, especially AtOnboardingConfig, are insufficiently `detailed
  • dependencies between parameters (e.g. rootEnvironment, domain and API key) are not made sufficiently clear
  • sensible default values for the parameters are not set
  • incompatible config settings are not rejected

Steps to reproduce

Use the widget with no prior knowledge

Additional info

No response

Relevant log output

No response

Flutter analyze output

No response

Flutter doctor output

No response

ksanty commented

Related issue - #583

JeremyTubongbanua commented

I can take this on - if no one is working on it already :) @gkc @sonle-geekyants

sonle-geekyants commented

I can take this on - if no one is working on it already :) @gkc @sonle-geekyants

Please check it for me. Thank you very much!