Niko/IOS docs to new template #551
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for eppo-data-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
leoromanovsky
requested changes
Dec 20, 2024
|
|
||
| 1. Choose `Package Dependencies` | ||
| 2. Click `+` and enter package URL: `[email protected]:Eppo-exp/eppo-ios-sdk.git` | ||
| 3. Set dependency rule to `Up to Next Minor Version` and select `Add Package` |
There was a problem hiding this comment.
great call out - this is important for customers to be able to get the latest patches
| } | ||
| ``` | ||
|
|
||
| [Continue with the rest of the quickstart content...] |
| @@ -0,0 +1,60 @@ | |||
| --- | |||
| title: Quickstart | |||
Comment on lines
+82
to
+90
| Task { | ||
| try await EppoClient.initialize( | ||
| sdkKey: "SDK-KEY-FROM-DASHBOARD", | ||
| initialConfiguration: try Configuration( | ||
| flagsConfigurationJson: Data(#"{ "pre-loaded-JSON": "passed in here" }"#.utf8), | ||
| obfuscated: false | ||
| ) | ||
| ); | ||
| } |
| If you'd like to initialize Eppo's client without performing a network request, you can use the `initializeOffline` method: | ||
|
|
||
| ```swift | ||
| try EppoClient.initializeOffline( |
| <ApiOptionRef | ||
| name="timestamp" | ||
| type="string" | ||
| defaultValue="undefined" |
There was a problem hiding this comment.
empty string for all https://github.com/Eppo-exp/eppo-ios-sdk/blob/main/Sources/eppo/Assignment.swift#L1
|
|
||
| ## How Assignments Work | ||
|
|
||
| The SDK periodically retrieves configuration rules from the Eppo server that define how subjects should be allocated to variants. When you call an assignment function, the SDK evaluates these rules locally without making additional network requests. |
There was a problem hiding this comment.
❌ No polling in Swift - configuration loaded once on session start and whenever user calls load()
Comment on lines
+46
to
+52
| if assignment == "version-a" { | ||
| showVersionA() | ||
| } else if assignment == "version-b" { | ||
| showVersionB() | ||
| } else { | ||
| showControl() | ||
| } |
There was a problem hiding this comment.
Suggested change
| if assignment == "version-a" { | |
| showVersionA() | |
| } else if assignment == "version-b" { | |
| showVersionB() | |
| } else { | |
| showControl() | |
| } | |
| switch assignment { | |
| case "version-a": | |
| showVersionA() | |
| case "version-b": | |
| showVersionB() | |
| default: | |
| showControl() | |
| } |
totally correct as-is just a suggestion
Comment on lines
+101
to
+123
| let defaultConfig = """ | ||
| { | ||
| "color": "#FF0000", | ||
| "fontSize": 14, | ||
| "fontFamily": "Roboto" | ||
| } | ||
| """ | ||
|
|
||
| let config = try eppoClient.getJSONStringAssignment( | ||
| flagKey: "ui-config", | ||
| subjectKey: user.id, | ||
| subjectAttributes: user.attributes, | ||
| defaultValue: defaultConfig | ||
| ) | ||
|
|
||
| // Parse and use the configuration | ||
| if let jsonData = config.data(using: .utf8), | ||
| let json = try? JSONSerialization.jsonObject(with: jsonData) as? [String: Any] { | ||
| let color = json["color"] as? String | ||
| let fontSize = json["fontSize"] as? Int | ||
| let fontFamily = json["fontFamily"] as? String | ||
| } | ||
| ``` |
Comment on lines
+204
to
+217
| ## Debugging Assignments | ||
|
|
||
| You may encounter situations where a flag assignment produces unexpected values. The SDK provides debugging functions to help understand how assignments are being made: | ||
|
|
||
| ```swift | ||
| let debugInfo = try eppoClient.getAssignmentDebugInfo( | ||
| flagKey: flagKey, | ||
| subjectKey: subjectKey, | ||
| subjectAttributes: subjectAttributes | ||
| ) | ||
|
|
||
| // Log debug information | ||
| print("Assignment debug info: \(debugInfo)") | ||
| ``` |
There was a problem hiding this comment.
❌ this API does not current exist in swift
| 1. Choose `Package Dependencies` | ||
| 2. Click `+` and enter package URL: `[email protected]:Eppo-exp/eppo-ios-sdk.git` | ||
| 3. Set dependency rule to `Up to Next Minor Version` and select `Add Package` | ||
| 4. Add to your project's target. |
There was a problem hiding this comment.
Somewhere in the code examples please show how to import the package:
import EppoFlagging
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split iOS SDK Documentation into Multiple Pages
Changes Made
Restructured single iOS.md file into multiple focused pages:
Why?
Review instructions
Before merge