-
Notifications
You must be signed in to change notification settings - Fork 343
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
Flutter SDK [DOC-811] #6088
Flutter SDK [DOC-811] #6088
Conversation
✅ Deploy Preview for segment-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! I have a few suggestions as we've changed the package name for the release.
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
|
||
See the [example app](https://github.com/segmentio/analytics_flutter/blob/main/example/README.md){:target="_blank"} to check a full test app of how to integrate Analytics-Flutter into your own Flutter app. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be worth adding a section here for people upgrading from pilot as there's a few steps they have to do. Not sure if it should be at the end or as part of the install instructions. Here's what I wrote in the readme:
## Upgrading from Pilot | |
Since pilot phase we have renamed the package of this library from `analytics` to `segment_analytics`. Some changes have to be applied after upgrading to the v1 package: | |
In your `pubspec.yaml` remove the `analytics` package and use `segment_analytics` instead. | |
```diff | |
- analytics: | |
- git: | |
- url: https://github.com/segmentio/analytics_flutter | |
- ref: main | |
- path: packages/core | |
+ segment_analytics: ^1.0.1 | |
``` | |
In your dart files change the imports from `package:analytics` to `package:segment_analytics`: | |
```diff | |
- import 'package:analytics/client.dart'; | |
+ import 'package:segment_analytics/client.dart'; | |
``` |
> The Analytics-Flutter library is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. For more information, see the [Analytics-Flutter GitHub repository](https://github.com/segmentio/analytics_flutter){:target="_blank"}. | ||
|
||
Analytics-Flutter enables you to seamlessly add Segment analytics to your Flutter1 app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stupid question: is it actually "Flutter1" or was that a typo? 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops sorry, that's a typo
|
||
## Utility methods | ||
The Analytics-Flutter utility methods help you work with plugins fro the analytics timeline. They include: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small typo: "fro" -> "from"
## Automatic screen tracking | ||
|
||
To set up automatic screen tracking, you need to add the analytics navigator observer to your app's navigator observers. For example, if you're using the `MaterialApp` class, add the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was confused by what Automatic Screen Tracking was until I read more in the Github repo - maybe we should include this context in these docs also:
Sending a
screen()
event with each navigation action will get tiresome, so you may want to track navigation globally.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm! I'm glad you made a pass, didn't realize our readme had so many little typos! 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly minor stuff.
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/flutter/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: pwseg <[email protected]>
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Proposed changes
Merge timing
Related issues (optional)