docs(hydrated_bloc): improve storagePrefix documentation

[JakesMD]

Status

READY

Breaking Changes

NO

Description

Currently, the default behavior of storagePrefix relies on the runtimeType. Overriding it is critically important for web applications. When the code structure changes, the minified runtimeType will change, leading to loss of state (see #4335 for more details).

Despite its importance, many developers are unaware of storagePrefix and its potential impact on data persistence.

Proposed Changes

• Update the documentation comment.
• Add a dedicated section to the README providing a more prominent explanation of storagePrefix.

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

[felangel]

@JakesMD thanks so much for the contribution! I left a bunch of small comments -- lmk what you think about my suggestions and I'll get these changes merged, thanks!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bdd9d5d) to head (6b11e87).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #4559   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           58        58           
  Lines         1733      1733           
=========================================
  Hits          1733      1733           

Flag	Coverage Δ
hydrated_bloc	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[JakesMD]

LGTM 👍

[felangel]

LGTM thanks so much for the contributions! ✅