Skip to content

Commit 47de517

Browse files
New experiment quickstart guide, small css updates (#492)
* rewrote experiment allocation quick start * update toc backgroun * update toc background * final copy edits
1 parent cfb7263 commit 47de517

14 files changed

+303
-83
lines changed

docs/home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ slug: /
66

77
import FeatureCard from '../src/components/FeatureCard';
88

9-
# What is Eppo?
9+
# Welcome to the Eppo Docs
1010

1111
Eppo is a composable next-generation feature flagging and experimentation platform focused on tightly integrating with your existing tech stack.
1212

docs/quick-starts/experiment-allocation-quickstart.md

Lines changed: 218 additions & 67 deletions
Large diffs are not rendered by default.

docs/quick-starts/feature-flag-quickstart.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ import * as EppoSdk from "@eppo/js-client-sdk";
184184
const eppoClient = EppoSdk.getInstance();
185185

186186
const variation = eppoClient.getBooleanAssignment(
187-
"new-checkout-page", // flag key
187+
"new-user-onboarding", // flag key
188188
user.id, // subject key
189189
{}, // userProperties
190190
false, // default value
@@ -203,7 +203,7 @@ import * as EppoSdk from "@eppo/node-server-sdk";
203203
const eppoClient = EppoSdk.getInstance();
204204

205205
const variation = eppoClient.getBooleanAssignment(
206-
"new-checkout-page", // flag key
206+
"new-user-onboarding", // flag key
207207
user.id, // subject key
208208
{}, // userProperties
209209
false, // default value
@@ -221,10 +221,10 @@ Task {
221221
do {
222222
try await EppoClient.initialize(sdkKey: "YOUR_EPPO_API_KEY");
223223
self.assignment = try EppoClient.shared().getBooleanAssignment(
224-
flagKey: "ios-test-app-treatment",
225-
subjectKey: "test-user",
226-
subjectAttributes: ["country": "US"],
227-
defaultVariation: "control"
224+
flagKey: "new-user-onboarding", // flag key
225+
subjectKey: "test-user", // subject key
226+
subjectAttributes: [], // subject attributes
227+
defaultVariation: "control" // default value
228228
);
229229
} catch {
230230
self.assignment = nil;
@@ -244,7 +244,11 @@ It is recommended to wrap initialization in a `Task` block in order to perform n
244244
import cloud.eppo.android.EppoClient;
245245

246246
EppoClient eppoClient = EppoClient.getInstance(); // requires the SDK to have already been initialized
247-
String variation = eppoClient.getStringAssignment("<FLAG KEY>", "<SUBJECT KEY>", "<DEFAULT VALUE>");
247+
String variation = eppoClient.getStringAssignment(
248+
"new-user-onboarding", // flag key
249+
"test-user", // subject key
250+
"control" // default value
251+
);
248252
```
249253

250254
</TabItem>
@@ -257,7 +261,7 @@ import eppo_client
257261
client = eppo_client.get_instance()
258262

259263
variation = eppoClient.get_boolean_assignment(
260-
"new-checkout-page", # flag key
264+
"new-user-onboarding", # flag key
261265
user.id, # subject key
262266
{}, # user properties
263267
false, # default value

src/css/custom.css

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ html {
7272
--card-shadow: rgba(0, 0, 0, 0.1);
7373
--inline-code-bg: #f0f0f0;
7474
--inline-code-color: #171717;
75+
--toc-background-color: #FCFAF7;
76+
--toc-border-color: #e0e0e0;
77+
--toc-text-color: #333;
78+
--toc-hover-color: #7964d3;
79+
--toc-font-family: 'Cofosans', Arial, sans-serif;
7580
--ifm-font-family-base: 'Cofosans', Arial, sans-serif;
7681
--ifm-font-family-monospace: 'Cofosansmono', Menlo, monospace;
7782
--ifm-h1-font-size: 2.25 rem;
@@ -96,6 +101,10 @@ html {
96101
--card-shadow: rgba(0, 0, 0, 0.3);
97102
--inline-code-bg: #2d2d2d;
98103
--inline-code-color: #e0e0e0;
104+
--toc-background-color: #282a36;
105+
--toc-border-color: #3d3d3d;
106+
--toc-text-color: #e0e0e0;
107+
--toc-hover-color: #7964d3;
99108
}
100109

101110
[data-theme='light'] .navbar {
@@ -105,6 +114,7 @@ html {
105114
background-color: #FCFAF7;
106115
}
107116

117+
108118
.docusaurus-highlight-code-line {
109119
background-color: rgba(0, 0, 0, 0.1);
110120
display: block;
@@ -177,7 +187,7 @@ sup {
177187
.theme-doc-sidebar-menu > .theme-doc-sidebar-item-category {
178188
margin-bottom: 1rem;
179189
padding-bottom: 0.3rem;
180-
border-bottom: 1px solid var(--ifm-sidebar-border-color);
190+
border-bottom: 0px solid var(--ifm-sidebar-border-color);
181191
}
182192

183193
.theme-doc-sidebar-menu > .theme-doc-sidebar-item-category:last-child {
@@ -231,20 +241,32 @@ sup {
231241
color: var(--ifm-color-gray-600);
232242

233243
/* Make the text a bit smaller */
234-
font-size: 0.7rem;
244+
font-size: 0.75rem;
235245

236246
/* Optional: Add some additional styling */
237247
font-weight: 600;
238248
text-transform: uppercase;
239249
padding-top: 0.1rem;
240250
padding-bottom: 0.1rem;
251+
252+
/* Remove hover effects */
253+
background-color: transparent !important;
241254
}
242255

243-
/* Ensure the color doesn't change on hover or when active */
244-
.theme-doc-sidebar-item-category-level-1 > .menu__list-item-collapsible > .menu__link:hover,
245-
.theme-doc-sidebar-item-category-level-1 > .menu__list-item-collapsible > .menu__link--active {
246-
color: var(--ifm-color-gray-600);
247-
background: none;
256+
.theme-doc-sidebar-item-category-level-2 > .menu__list-item-collapsible > .menu__link,
257+
.theme-doc-sidebar-item-link-level-2 > .menu__link {
258+
padding-left: 0;
259+
}
260+
261+
262+
/* Remove hover effects for the parent element as well */
263+
.theme-doc-sidebar-item-category-level-1 > .menu__list-item-collapsible:hover {
264+
background-color: transparent !important;
265+
}
266+
267+
/* Ensure the text color doesn't change on hover */
268+
.theme-doc-sidebar-item-category-level-1 > .menu__list-item-collapsible > .menu__link:hover {
269+
color: var(--ifm-color-gray-600) !important;
248270
}
249271

250272
/* For dark mode */
@@ -327,3 +349,46 @@ code {
327349
font-size: 0.7em; /* Adjust this value as needed */
328350
}
329351
}
352+
353+
/* Adjust these values as needed */
354+
h1 {
355+
font-size: 2rem;
356+
}
357+
358+
h2 {
359+
font-size: 1.5rem;
360+
}
361+
362+
h3 {
363+
font-size: 1.25rem;
364+
}
365+
366+
h4 {
367+
font-size: 1rem;
368+
}
369+
370+
/* Style the Table of Contents */
371+
.table-of-contents {
372+
border-left: none !important;
373+
background-color: var(--toc-background-color);
374+
border-radius: 8px; /* Rounded corners */
375+
padding: 16px; /* Add some padding inside the box */
376+
}
377+
378+
/* Style the TOC links */
379+
.table-of-contents__link {
380+
color: var(--toc-text-color);
381+
}
382+
383+
.table-of-contents__link--active {
384+
font-weight: bold;
385+
color: var(--toc-hover-color)
386+
}
387+
388+
.theme-doc-sidebar-container {
389+
border-right: none !important;
390+
}
391+
392+
img {
393+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
394+
}
379 KB
Loading
363 KB
Loading
299 KB
Loading
355 KB
Loading
253 KB
Loading
358 KB
Loading

0 commit comments

Comments
 (0)