docs(sentry-dio): improve addSentry method documentation

[tsinis]

📜 Description

Improves the addSentry() method documentation in the sentry_dio package with clearer usage examples and explanation.

The updated docs now clearly explain that Sentry should be added as the last step in Dio configuration, ensuring that it uses the user's custom configuration rather than overriding it. Kudos to @ueman.

💡 Motivation and Context

When integrating Sentry with Dio, users need to understand the correct order of operations. Previously, the documentation didn't fully clarify that addSentry() should be called last after any custom transformer or adapter configuration. This led to confusion when users wanted to use custom Dio components alongside Sentry.

This documentation improvement addresses the "Next steps" item from the previous PR that exported SentryTransformer, by explaining how addSentry() works with custom configurations.

💚 How did you test it?

• Verified that the documentation is technically accurate with respect to how addSentry() functions.
• Ensured the documentation provides clear guidance on integration order.

📝 Checklist

• I reviewed submitted code
• Tests are not needed for documentation changes
• No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
• I updated the docs (that's what this PR is about)
• All tests passing
• No breaking changes

#skip-changelog

[buenaflor]

Thanks!

Do you mind also fixing the sentry docs for this? This is important info and isn't mentioned there.

Otherwise I can take care of that :)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.93%. Comparing base (18b7c08) to head (1d0f39d).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2912      +/-   ##
==========================================
+ Coverage   87.63%   96.93%   +9.30%     
==========================================
  Files         272        9     -263     
  Lines        9047      163    -8884     
==========================================
- Hits         7928      158    -7770     
+ Misses       1119        5    -1114     

☔ 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.

[tsinis]

Thanks!

Do you mind also fixing the sentry docs for this? This is important info and isn't mentioned there.

Otherwise I can take care of that :)

Hi @buenaflor, sure, here is sentry-docs counterpart. Thanks!