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

Niko/android to new template #550

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Conversation

nikomancy
Copy link
Contributor

@nikomancy nikomancy commented Dec 16, 2024

Split Android SDK Documentation into Multiple Pages

Changes Made

Restructured single android.md file into multiple focused pages:

  • intro.mdx: High-level overview and quick links
  • quickstart.mdx: Getting started guide
  • initialization.mdx: Detailed initialization options
  • assignments.mdx: Comprehensive assignment types and patterns

Why?

  • The goal is to make the learning journey for engineers working with specific SDKs easier.
  • Content is easier to find in the TOC improving navigability.
  • Code samples for typed examples have been added for ease of use.
  • Boilerplate prose docs have been added to allow engineers to learn about relevant conceptual information along side the code without having to context switch to other parts of the docs.

Review instructions

  • The code samples for typed assignments were inferred from the existing code samples and and the Javascript SDK's parameters. Please check those code samples and confirm that they are actually correct.

To Do before Merge

  • Delete android.md
  • Update redirects

nikomancy and others added 16 commits December 5, 2024 10:28
* add precomputed assignments documentation for JS client

* very nice!

* globally

* Update docs/sdks/client-sdks/javascript/precomputed-assignments.mdx

Co-authored-by: Sameeran Kunche <[email protected]>

---------

Co-authored-by: Sameeran Kunche <[email protected]>
* Update precomputed-assignments.mdx evaluation example

* Update docs/sdks/client-sdks/javascript/precomputed-assignments.mdx

Co-authored-by: Sameeran Kunche <[email protected]>

---------

Co-authored-by: Sameeran Kunche <[email protected]>
…droid SDK documentation and clean up the introduction section by removing the API Reference card.
Copy link

netlify bot commented Dec 16, 2024

Deploy Preview for eppo-data-docs ready!

Name Link
🔨 Latest commit 407a375
🔍 Latest deploy log https://app.netlify.com/sites/eppo-data-docs/deploys/675f8409aa476000088f9dea
😎 Deploy Preview https://deploy-preview-550--eppo-data-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


```groovy
dependencies {
implementation 'cloud.eppo:android-sdk:4.0.0'
Copy link
Member

Choose a reason for hiding this comment

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

mind bumping this version to 4.3.3 which is the latest?

Suggested change
implementation 'cloud.eppo:android-sdk:4.0.0'
implementation 'cloud.eppo:android-sdk:4.3.3'


### Initialize the SDK

First, initialize the SDK with your API key. You'll need to do this early in your application lifecycle, typically in your Application class:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
First, initialize the SDK with your API key. You'll need to do this early in your application lifecycle, typically in your Application class:
First, initialize the SDK with your API key. You'll need to do this early in your application lifecycle, typically in your `Application` subclass:

EppoClient eppoClient = EppoClient.getInstance();

String flagKey = "new-landing-page";
String subjectKey = getUserId() || "anonymous";
Copy link
Member

Choose a reason for hiding this comment

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

you can't use the || operator like this in Java (unlike Javascript).
You have to do instead:

String subjectKey = getUserId() != null ? getUserId() : "anonymous";

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants