diff --git a/README.md b/README.md index 85382aafd..e203313fc 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,8 @@ A single line of code gives you a fully-featured devkit for building natively pe ## Getting Started -> In this example, we will use CodePen to avoid installing a web server locally. +> 🏖ī¸ **Just for your convenience** +> We will be using CodePen for all of the examples in this tutorial because it lets you play with them right in the browser. Follow the steps below to connect the playground with CodePen: @@ -61,8 +62,9 @@ Follow the steps below to connect the playground with CodePen: Connecting

-> You will typically use an API key to connect to your development, staging, or production environments in real cases, -> but you can also use a local URL, such as `https://localhost/myapp`. +> 💡ī¸ **Hint** +> You will typically use an API key to connect to your development, staging, or production environments in real cases, +> but you can also use a local URL, such as `https://localhost/myapp`. Now, try evaluating the expression below: diff --git a/docs/evaluator.md b/docs/evaluator.md index 9187c1a14..1e25960f8 100644 --- a/docs/evaluator.md +++ b/docs/evaluator.md @@ -12,10 +12,11 @@ This method evaluates an expression written in CQL. Check out our [quick start guide](quick-start.md) for an introduction to what is CQL and how it works. -> **Notice** -> Currently, we impose a hard limit of 300 character on the length of expression. +> ℹī¸ī¸ **Note** +> We currently impose a hard limit of 300 characters on the length of expression. > We plan to remove this limitation in the near future. + ### Signature The `evaluation` method has the following signature: diff --git a/docs/plug.md b/docs/plug.md index 9e5369599..4da3a08b1 100644 --- a/docs/plug.md +++ b/docs/plug.md @@ -55,7 +55,7 @@ These are the currently supported options: The token scope determines how the SDK synchronize the token across multiple tabs to match your application's behaviour. -> **Notice** +> ℹī¸ī¸ **Note** > Although the SDK supports multiple identified users in different tabs, such separation does not apply > to anonymous users. For the SDK, there is only one anonymous user per browser, regardless of the scope. @@ -210,8 +210,8 @@ This method evaluates an expression written in CQL. Check out our [quick start guide](quick-start.md) for an introduction to what is CQL and how it works. -> **Notice** -> Currently, we impose a hard limit of 300 character on the length of expression. +> ℹī¸ī¸ **Note** +> We currently impose a hard limit of 300 characters on the length of expression. > We plan to remove this limitation in the near future. ### Signature diff --git a/docs/quick-start.md b/docs/quick-start.md index 8d2e956d8..d920c83d1 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -83,7 +83,8 @@ value-driven customer relationships. ## Setting Up -> For convenience, we will use CodePen for playing with the examples provided throughout this guide. +> 🏖ī¸ **Just for your convenience** +> We will be using CodePen for all of the examples in this tutorial because it lets you play with them right in the browser. Follow the steps below to connect the playground with CodePen: @@ -103,8 +104,9 @@ After the page loads, you should notice an indication on the playground tab that Switching back to the playground tab, you should see a notification saying _"Connection established"_ that indicates the playground is now connected to the CodePen editor. +> 💡ī¸ī¸ **Hint** > You will typically use an API key to connect to your development, staging, or production environments in real cases, -> but you can also use a local URL, such as `https://localhost/myapp`. +> but you can also use a local URL, such as `https://localhost/myapp`. Now, let's get our hands dirty and play around with CQL! @@ -166,6 +168,10 @@ Simply copy the code below and paste into the HTML panel to see it in action: After CodePen updates the preview, you should see an alert saying _"Welcome!"_ or _"Welcome back!"_ depending on whether it is your first time playing around with CQL on CodePen. +> 🐞 **It's not a bug. It's a feature, we swear!** +> Sessions expire after 30 minutes of inactivity in the sandbox environment, and we erase all data every hour. +> So the _returning user_ expression will only evaluate to true in that half an hour window after the session expires. + Note that you are not limited to boolean expressions only. For example, let's update the example again to show how many sessions you have had: @@ -196,7 +202,8 @@ interesting questions like: These are just a few of the many questions you can ask based on anonymous information automatically collected by the SDK. -> Croct does not automatically collect sensitive information that can identify the user, such as GPS coordinates or +> 🛡ī¸ **We embrace privacy by design** +> We do not automatically collect sensitive information that can identify the user, such as GPS coordinates or > values entered in fields. We have [open-sourced the SDK](https://github.com/croct-tech/sdk-js) as an effort to bring > more transparency about data collection. @@ -430,6 +437,7 @@ Anonymize When identifying a user, the personalization engine automatically takes care of unifying sessions and profiles in the background without a single extra line of code. +> ⚠ī¸ **Important** > Never use guessable attributes as an identifier, such as email, phone, or incremental IDs. Instead, > we strongly recommend using a cryptographically-secure UUID v4 generator. diff --git a/docs/tracker.md b/docs/tracker.md index 1e7563615..cabc2154b 100644 --- a/docs/tracker.md +++ b/docs/tracker.md @@ -51,7 +51,7 @@ croct.tracker.enable(); This method disables automatic event tracking. -> **Notice** +> 💡ī¸ **Hint** > You can still track events by calling the [`track`](#track) method even with automatic event tracking disabled. ### Signature