Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add section on modeling state #4201

Merged
merged 4 commits into from
Sep 3, 2024

Conversation

EchoEllet
Copy link
Contributor

@EchoEllet EchoEllet commented Jul 11, 2024

Status

IN DEVELOPMENT/HOLD

Breaking Changes

No

Description

Add a new section Modeling States to covert the common approaches that are suggested by the Bloc library.

  • We could extract the code examples as components
    so this section can be localizable without duplicating them.
  • I haven't used Bloc in a fully scalable Flutter/Dart application yet, so I expect some minor or major design issues.
  • The docs can be improved further.
    For example, we might consider providing different or better examples, as well as a minimal example of updating the state from the Bloc/Cubit though it can be out of scope for this section.
  • The name status for the third approach could be improved or changed if needed.

We could consider closing this PR in case it's not suitable.

I'm open to all feedback, feel free to request any changes or commit them directly.

Screenshots

Screenshot 1

Screenshot 2

Screenshot 3

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

@EchoEllet EchoEllet marked this pull request as ready for review August 25, 2024 00:56
Copy link
Owner

@felangel felangel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks so much for the contribution! 💙

@felangel felangel added the documentation Documentation requested label Sep 3, 2024
@felangel felangel changed the title docs: modeling states docs: add section on modeling state Sep 3, 2024
@felangel felangel merged commit c5382a4 into felangel:master Sep 3, 2024
9 checks passed
@EchoEllet
Copy link
Contributor Author

Thank you for the feedback.

@EchoEllet EchoEllet deleted the docs/modeling-states branch September 3, 2024 02:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants