felangel/bloc

Docs: migrating from library X

Open

#1,837 opened on Oct 17, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Dart (12,452 stars) (3,419 forks)batch import
documentationgood first issue

Description

Is your feature request related to a problem? Please describe. Currently, migrating from another library requires you to do a manual comparison of samples from both libraries to fill in the gaps. It would be nice to have documentation for people migrating from other popular state management solutions, such as ChangeNotifier, StateNotifier, MobX, or Redux.

Describe the solution you'd like Identify a few state management libraries that are good candidates for migration documentation. Documentation should mirror Flutter's for migrating from X (React Native, Android, etc.)

Describe alternatives you've considered The current alternative is for people to do the mental translation themselves rather than having ready documentation to review.

Additional context Flutter migration examples:

https://flutter.dev/docs/get-started/flutter-for/react-native-devs https://flutter.dev/docs/get-started/flutter-for/android-devs

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of blocfamiliarity with at least one other state management library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue proposes creating migration documentation similar to Flutter's 'Flutter for X devs' pages. Look at the bloc repository's documentation structure (e.g., `docs/` folder) and create a new section for migration guides. Reference Flutter's examples at https://flutter.dev/docs/get started/flutter for/ and adapt the format for bloc. The task does not require code changes, only writing markdown files.