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(ios): update feature documentation #1863

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

adwinross
Copy link
Collaborator

Description

iOS documentation added

Related issue

Closes #1583

Copy link

vercel bot commented Mar 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
measure-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 14, 2025 5:44am

@adwinross adwinross added docs user facing documentation ios ios related labels Mar 5, 2025
@adwinross adwinross self-assigned this Mar 5, 2025
@adwinross adwinross requested a review from abhaysood March 5, 2025 08:49
@@ -7,5 +7,11 @@
All the features supported by the Measure SDK are listed below.

* [App launch](features/feature_app_launch.md)
* [Crash tracking](features/feature_crash_tracking.md)
* [Network monitoring](features/feature_network_monitoring.md)
* [Network changes](features/feature_network_changes.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

In the network changes documentation we should clearly mention that this is only available upto iOS 16.4.

Copy link
Contributor

Choose a reason for hiding this comment

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

We should also consider removing it if this will no longer be available in fufture and if there are no alternatives.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

created a issue for this here.

@@ -7,5 +7,11 @@
All the features supported by the Measure SDK are listed below.

* [App launch](features/feature_app_launch.md)
* [Crash tracking](features/feature_crash_tracking.md)
* [Network monitoring](features/feature_network_monitoring.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Give a more detailed usage example to use NetworkInterceptor.
  • Consider renaming the NetworkInterceptor to MsrNetworkInterceptor.
  • Anything that requires manual setup must also be documented in the main README.md file.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

created a issue for this here.

Copy link
Contributor

@abhaysood abhaysood left a comment

Choose a reason for hiding this comment

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

Added some more comments, can merge after they are resolved.


| Screenshot | Layout snapshot |
|-------------------------------------------------------|--------------------------------------------------|
| ![Screenshot](../images/layoutSnapshotScreenshot.png) | ![Layout Snapshot](../images/layoutSnapshot.svg) |
Copy link
Contributor

Choose a reason for hiding this comment

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

The image size difference between screenshot and layout snapshot is too large. Try making them the same dimensions. Otherwise it looks like this:

image

Comment on lines +30 to +32
[Task Info](https://web.mit.edu/darwin/src/modules/xnu/osfmk/man/task_info.html)
[iOS Memory Deep Dive](https://developer.apple.com/videos/play/wwdc2018/416/)
[Apple Developer Forum Thread](https://developer.apple.com/forums/thread/105088)
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a new line or a bullet point for each link. Otherwise they look like one sentence.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs user facing documentation ios ios related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add feature documentation
2 participants