Skip to content

Commit decf2b2

Browse files
authored
Collapsible sidebar categories and improved titles (#1060)
* change navbar * green instead of froggy * support tweaks * fixes * sidebar approachability * welcome * fix * entitlements category * clarify trusted entitlements * offerings * fix * uncollapse support
1 parent db39723 commit decf2b2

File tree

8 files changed

+143
-83
lines changed

8 files changed

+143
-83
lines changed

docs/customers/trusted-entitlements.mdx

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,35 @@ hidden: false
77

88
RevenueCat uses strong SSL to secure communications against interception. But the user is in control of the client device, and, while not an easy process, they can configure it to allow and execute [MiTM](https://en.wikipedia.org/wiki/Man-in-the-middle_attack) attacks to grant themselves entitlements without actually paying you.
99

10-
To prevent this, in addition to SSL for secure communications, our native (iOS/Android) SDKs, together with our backend, will verify responses integrity by checking a cryptographic signature.
10+
**Trusted Entitlements** helps you detect and respond to such attacks. When enabled, our native (iOS/Android) SDKs work together with our backend to verify response integrity by checking a cryptographic signature on entitlement data. This verification result is then provided to your app, allowing _you_ to decide how to handle potentially compromised entitlements.
1111

1212
:::info
1313
Trusted Entitlements is supported in iOS SDK version 4.25.0 and up, and Android SDK version 6.6.0 and up.
1414
:::
1515

1616
## Setup
1717

18-
### Configuration
18+
### Default Behavior
1919

20-
Trusted Entitlements is enabled by default and it doesn't have any impact on performance or behavior by default. You can disable it by doing the following:
20+
**For newer SDK versions (iOS 5.15.0+, Android 8.11.0+):**
2121

22-
:::info
23-
Trusted Entitlements are disabled by default for versions under 5.15.0 in iOS and 8.11.0 in Android.
22+
- Trusted Entitlements is **enabled by default** - the SDK will provide verification data
23+
- **However, verification results are informational only** - your app must check the verification result and decide how to handle unverified entitlements
24+
- No automatic blocking or rejection of unverified entitlements occurs
25+
26+
**For older SDK versions (iOS 4.25.0-5.14.x, Android 6.6.0-8.10.x):**
27+
28+
- Trusted Entitlements is **disabled by default** - no verification data is provided
29+
- You must explicitly enable it to get verification information
30+
31+
:::warning Important
32+
**Enabling Trusted Entitlements does not automatically protect your app.** The SDK provides verification data, but it's your responsibility to check the verification result in your code and decide whether to grant access based on unverified entitlements.
2433
:::
2534

35+
### Configuration
36+
37+
**To disable Trusted Entitlements** (when it's enabled by default):
38+
2639
import content1 from "@site/code_blocks/customers/trusted-entitlements.swift?raw";
2740
import content2 from "@site/code_blocks/customers/trusted-entitlements.m?raw";
2841
import content3 from "@site/code_blocks/customers/trusted-entitlements.kt?raw";
@@ -64,6 +77,14 @@ import content7 from "@site/code_blocks/customers/trusted-entitlements.cs?raw";
6477
]}
6578
/>
6679

80+
**To enable Trusted Entitlements** (for older SDK versions where it's disabled by default):
81+
82+
Use the same configuration as above, but set the mode to `EntitlementVerificationMode.informational` instead of `EntitlementVerificationMode.disabled`.
83+
84+
:::info
85+
Trusted Entitlements has no impact on performance or behavior when enabled.
86+
:::
87+
6788
### Verification
6889

6990
When Trusted Entitlements are enabled, `EntitlementInfo` contains the verification result:

docs/getting-started/entitlements.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
---
22
title: Entitlements
3+
description: Use Entitlements to manage access to content in your app
4+
sidebar_label: Overview
5+
hidden: false
36
---
47

58
{/* I'm including this, because this doc historically had a lot of information on product configuration, and not just entitlements. this is to keep some kind of continuity for legacy links to this page */}

docs/offerings/offerings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Offerings
3+
description: Group products together to display to users in a paywall
34
sidebar_label: Offerings
45
slug: overview
56
---

docs/offerings/virtual-currency.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@
22
title: Virtual Currency
33
sidebar_label: Virtual Currency
44
slug: virtual-currency
5+
description: Enable transactions for virtual items in your app
56
hidden: false
67
---
78

8-
Virtual currencies are digital assets used within your app to facilitate transactions, unlock premium features, or enhance customer engagement. These currencies are typically acquired through in-app purchases, rewards, or gameplay achievements and do not have intrinsic real-world value outside the application. They can be used for purchasing virtual goods, upgrading characters, or accessing exclusive content. Common examples include tokens, coins, credits, or other units that can be replenished through purchases. You can leverage virtual currencies to monetize apps, encourage customer retention, and create a more immersive experience.
9+
Virtual currencies are digital assets used within your app to facilitate transactions, unlock premium features, or enhance customer engagement.
10+
11+
These currencies are typically acquired through in-app purchases, rewards, or gameplay achievements and do not have intrinsic real-world value outside the application. They can be used for purchasing virtual goods, upgrading characters, or accessing exclusive content. Common examples include tokens, coins, credits, or other units that can be replenished through purchases.
12+
13+
You can leverage virtual currencies to monetize apps, encourage customer retention, and create a more immersive experience.
914

1015
:::info
1116
This feature is in an early stage and under active development. While what's available today is stable and ready to use, we're continuing to expand its capabilities.

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ const config = {
278278
docs: {
279279
sidebar: {
280280
autoCollapseCategories: true,
281-
hideable: false,
281+
hideable: true,
282282
},
283283
},
284284
metadata: [

0 commit comments

Comments
 (0)