Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
170 commits
Select commit Hold shift + click to select a range
56b9b01
Added new entry for understanding metrics and for interpreting results
chris-absmartly Jan 13, 2025
7099c41
Added information about sampling of visitors in performance graph
chris-absmartly Jan 13, 2025
e5e2bc6
Fixed image
chris-absmartly Jan 13, 2025
e5f53b0
added max image size
chris-absmartly Jan 13, 2025
31466e1
added new image path
chris-absmartly Jan 13, 2025
c7a7cb0
Reverted to Image component
chris-absmartly Jan 13, 2025
60027b3
trying to fix the image
chris-absmartly Jan 13, 2025
f63db26
remove comments
chris-absmartly Jan 13, 2025
a7a38d5
add max image sizes to all pages
chris-absmartly Jan 13, 2025
4652acd
add new experiment create article
chris-absmartly Jan 14, 2025
c1ee9b3
fix image
chris-absmartly Jan 14, 2025
e7fd912
typo in file name
chris-absmartly Jan 14, 2025
beab2ab
fix broken link to types-of-analysis
chris-absmartly Jan 14, 2025
15503a4
improve aborting article
chris-absmartly Jan 14, 2025
2c0f922
Added new entry for Health checks
chris-absmartly Jan 16, 2025
b6b4772
remove old comment which breaks the build
chris-absmartly Jan 16, 2025
ed2df1c
fix image size + back link from aborting page
chris-absmartly Jan 16, 2025
0679491
mispelled width
chris-absmartly Jan 16, 2025
f87bf62
adjust image sizes
chris-absmartly Jan 16, 2025
0e96c17
rephrase intro text
chris-absmartly Jan 16, 2025
17446cb
Removed old dashboard page
chris-absmartly Jan 16, 2025
5b7d668
reformulated aborting doc
chris-absmartly Jan 16, 2025
61a2602
adding experiment report entry on KB
chris-absmartly Feb 3, 2025
8b5c6b7
fix broken link
chris-absmartly Feb 3, 2025
9e6da3a
correct some typos
chris-absmartly Feb 3, 2025
9d8bc63
some more typos
chris-absmartly Feb 3, 2025
7c52444
add tip about celebrating learning
chris-absmartly Feb 3, 2025
3f5a576
added linked to FH/GST
chris-absmartly Feb 3, 2025
2b1aa2b
address Cal's feedback
chris-absmartly Feb 3, 2025
25bddf5
fix: remove exact versions from sdk install commands
calthejuggler Feb 5, 2025
376f63f
fix: update variable values to be the variable key
calthejuggler Feb 27, 2025
f4d79ab
fix: peek variable value docs
calthejuggler Feb 27, 2025
310ce40
feat: add Zuko integration docs
calthejuggler Feb 25, 2025
236ef0a
feat: add Zuko logo
calthejuggler Mar 12, 2025
b105666
Added documentation for decisions overview
chris-absmartly Mar 3, 2025
53328da
fixed a few typos
chris-absmartly Mar 3, 2025
f7be727
Added decisions timeline
chris-absmartly Mar 4, 2025
9fa4822
typos in aborting experiments
chris-absmartly Mar 4, 2025
6499f30
fix: broken urls in experiment reports page
calthejuggler Mar 13, 2025
b687ca6
fix: broken links
calthejuggler Mar 13, 2025
b2c330f
fix: add peekVariableValue to all programming languages
calthejuggler Mar 20, 2025
a8cfa0e
added managing team entry in wiki (#231)
chris-absmartly Jun 4, 2025
a218fe4
feat: add release notes section
calthejuggler Jun 18, 2025
ecde764
feat: add release notes section
calthejuggler Jun 18, 2025
fe1cec9
2025 july release notes (#232)
chris-absmartly Jul 7, 2025
aa29367
added managing team entry in wiki
chris-absmartly Jun 2, 2025
c2d221e
Fixed a few typos
chris-absmartly Jun 2, 2025
89b9fc8
and more typos
chris-absmartly Jun 2, 2025
c1451a5
change file name to refect the H1
chris-absmartly Jun 2, 2025
efd6519
Add August notes
chris-absmartly Sep 2, 2025
c1e261b
Thanks Rabbit
chris-absmartly Sep 2, 2025
5323a13
Rabbit 2.0
chris-absmartly Sep 2, 2025
0928cb9
and again
chris-absmartly Sep 2, 2025
9e30962
fix: minor code rabbit fix
calthejuggler Sep 3, 2025
82248fa
october release notes
chris-absmartly Oct 7, 2025
c85a9fe
Initial version, no screenshot
chris-absmartly Oct 30, 2025
1eb13fc
fix: minor formatting
calthejuggler Sep 3, 2025
61fc470
feat: add double underscore note to varibale conflict alert (#234)
calthejuggler Oct 7, 2025
bf6c439
fix: put treatment into a variable
calthejuggler Oct 16, 2025
9e2fee9
typo
chris-absmartly Oct 31, 2025
f96a58d
added images
chris-absmartly Oct 31, 2025
bce7117
typo and image links
chris-absmartly Oct 31, 2025
a483b34
add hero image
chris-absmartly Oct 31, 2025
3692c00
new image for new website
chris-absmartly Oct 31, 2025
1c7f2a5
new install guide for launchPad
chris-absmartly Nov 3, 2025
3b0ca10
Fix LaunchPad installation docs and add DOM Changes SDK plugin section
Nov 3, 2025
67c603d
Update Chrome Web Store screenshot to landscape resolution (1920x1080)
Nov 3, 2025
3672582
Add direct link to Chrome Web Store and update screenshot
Nov 3, 2025
843d030
Added setup guide for Chrome Extension
chris-absmartly Nov 3, 2025
a8451a6
typos
chris-absmartly Nov 3, 2025
ac89e16
applied suggested rabbit suggestions
chris-absmartly Nov 3, 2025
77cb2fd
Added november release notes and how to guide for ownership model
chris-absmartly Nov 4, 2025
194fbef
fix path to image folder
chris-absmartly Nov 4, 2025
576a7d1
I fixed the path in the wrong file
chris-absmartly Nov 4, 2025
2931a43
broken link to how to guide
chris-absmartly Nov 4, 2025
bc3064c
added data retenion entry
chris-absmartly Nov 4, 2025
d84d136
fix image width and action items
chris-absmartly Nov 4, 2025
f60abb5
make the rabbit happy
chris-absmartly Nov 4, 2025
64e897e
clarified retention policy
chris-absmartly Nov 4, 2025
1e2f850
remove video placeholder
chris-absmartly Nov 4, 2025
bfa79b6
New events documentation
chris-absmartly Nov 14, 2025
589186a
Added missing images
chris-absmartly Nov 14, 2025
001eb33
Merge branch 'development' into new-kb
chris-absmartly Nov 14, 2025
63bb308
Fixed typocs and removed all files + images
chris-absmartly Nov 14, 2025
0e474b8
Added Applications and Units pages in Configuration
chris-absmartly Nov 14, 2025
68af71b
Fix broekn paths to settings
chris-absmartly Nov 14, 2025
2595d35
Added Teams & Users
chris-absmartly Nov 14, 2025
813cbd1
more broken links
chris-absmartly Nov 14, 2025
d0cc0b2
and again
chris-absmartly Nov 14, 2025
9b25f73
add new KB folders for metric, experiments and FF
chris-absmartly Nov 14, 2025
687fc9b
broken link to metric pages
chris-absmartly Nov 14, 2025
96dfd60
added goals & metrics pages
chris-absmartly Nov 17, 2025
3e2b221
fixed broken links
chris-absmartly Nov 17, 2025
72f4d26
fix typo
chris-absmartly Nov 17, 2025
4eb651d
Merged metric groups into overview
chris-absmartly Nov 18, 2025
b6a2b4e
added Metrics overview
chris-absmartly Nov 18, 2025
3970b1c
added some of the metrics type
chris-absmartly Nov 18, 2025
1289dc7
added metric metadata
chris-absmartly Nov 20, 2025
555d8bf
Fixed path to settings
chris-absmartly Nov 20, 2025
07ed473
Attempt to explain goal ownership and permissions
chris-absmartly Nov 20, 2025
e9fabf4
one more broken link
chris-absmartly Nov 20, 2025
c10dc45
again
chris-absmartly Nov 20, 2025
e97cfe9
Added outliers and metrics filters
chris-absmartly Nov 21, 2025
928bb18
fixed some formating issues
chris-absmartly Nov 21, 2025
e601834
added goal relations draft
chris-absmartly Nov 21, 2025
b0419ee
added goal relations images + alert thresholds
chris-absmartly Nov 21, 2025
ca17fb8
added formating information
chris-absmartly Nov 21, 2025
037f4ab
added image to support formatting
chris-absmartly Nov 21, 2025
1513fd4
Outliers are capped and not excluded
chris-absmartly Nov 21, 2025
082abdf
added versioning info
chris-absmartly Nov 21, 2025
f4fd8bc
added metrics ownership and versionsioning info
chris-absmartly Nov 24, 2025
f3b7419
added new metric type pages
chris-absmartly Nov 24, 2025
0b87a85
move experiments pages to dedicated folder. I expect many broken links
chris-absmartly Nov 24, 2025
d51c6f8
fixed broken links
chris-absmartly Nov 24, 2025
643ef2f
added experiment overview
chris-absmartly Nov 24, 2025
302251c
added GT and Fixed Horizon info
chris-absmartly Nov 24, 2025
b002def
added oermissions
chris-absmartly Nov 24, 2025
7f549e1
added Launchpad info
chris-absmartly Nov 24, 2025
1e01785
broken link to images
chris-absmartly Nov 24, 2025
ff7587b
Added Users, Teams & Roles entries
chris-absmartly Nov 24, 2025
c6ca5e8
added team info
chris-absmartly Nov 24, 2025
caa17f8
reordered the menu
chris-absmartly Nov 25, 2025
cb5f0c1
updated navigation
chris-absmartly Nov 25, 2025
20dcdff
fix issue with index
chris-absmartly Nov 25, 2025
b9504c4
create API & SDK folder
chris-absmartly Nov 28, 2025
d834cf4
even better structure
chris-absmartly Nov 28, 2025
63bc474
broken links to SSO
chris-absmartly Nov 28, 2025
5b837a2
fix link to SDK documentation
chris-absmartly Nov 28, 2025
beb009f
Some more broken links to sdk doc
chris-absmartly Nov 28, 2025
8b1d787
move auto-generated content to the correct place
chris-absmartly Nov 28, 2025
91a801b
fix links to SDK-API
chris-absmartly Nov 28, 2025
7b2b083
and again
chris-absmartly Nov 28, 2025
740e83f
add get started guide
chris-absmartly Nov 28, 2025
0038e05
workding change get started
chris-absmartly Nov 28, 2025
7b95423
try home page redirect
chris-absmartly Nov 28, 2025
4db0644
that did not work
chris-absmartly Nov 28, 2025
3b84a77
again
chris-absmartly Nov 28, 2025
6ce4923
and that?
chris-absmartly Nov 28, 2025
9ab08a8
use relative path
chris-absmartly Nov 28, 2025
167293a
added get started guide
chris-absmartly Dec 1, 2025
82a8cba
added link to SDKs doc in header
chris-absmartly Dec 1, 2025
e3126c4
added links to get started guide
chris-absmartly Dec 1, 2025
45fceed
typo in link
chris-absmartly Dec 1, 2025
2dc1bde
link to SDK
chris-absmartly Dec 1, 2025
598296d
stil ldoes not work
chris-absmartly Dec 1, 2025
6afb560
rename landing to overview
chris-absmartly Dec 1, 2025
5bf5b10
added more link to get started guide
chris-absmartly Dec 1, 2025
623bacf
added teams documentation
chris-absmartly Dec 1, 2025
c5c1229
some typo in Team
chris-absmartly Dec 1, 2025
a01e7fe
added glossary
chris-absmartly Dec 2, 2025
22995a5
A and B in glossary
chris-absmartly Dec 2, 2025
fa02653
new C entries
chris-absmartly Dec 2, 2025
8b4dba2
try better formatting
chris-absmartly Dec 2, 2025
0522cde
E and F
chris-absmartly Dec 2, 2025
3939022
broken anchor
chris-absmartly Dec 2, 2025
a5bbcd5
forgot another anchor
chris-absmartly Dec 2, 2025
45798ae
broken external link
chris-absmartly Dec 2, 2025
50388d0
G and H
chris-absmartly Dec 5, 2025
5dd74af
M
chris-absmartly Dec 5, 2025
fe30b68
N, O
chris-absmartly Dec 5, 2025
101116d
Added some more entried to the glossary
chris-absmartly Dec 12, 2025
19585d6
fixed some typo
chris-absmartly Dec 12, 2025
53b6f93
added december release notes
chris-absmartly Dec 19, 2025
10391d6
Added missing images
chris-absmartly Dec 19, 2025
1906b01
P, Q, R, S
chris-absmartly Dec 19, 2025
7104e97
done
chris-absmartly Dec 19, 2025
772239c
typos
chris-absmartly Dec 19, 2025
4307442
more typos
chris-absmartly Dec 19, 2025
d51fef7
and more
chris-absmartly Dec 19, 2025
b30afb2
feat: add hybrid redirect system for URL structure changes
joalves Jan 7, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
# Generated files
.docusaurus
.cache-loader
/docs/SDK-API/*.mdx
/docs/APIs-and-SDKs/SDK-API*.mdx
/docs/Web-Console-API/*.mdx
/docs/SDK-API/*.js
/docs/APIs-and-SDKs/SDK-API*.js
/docs/Web-Console-API/*.js

# Misc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Image from "@theme/IdealImage";

# Code as a Variant Variable

[Variant Variables](/docs/SDK-Documentation/basic-usage#treatment-variables)
[Variant Variables](/docs/APIs-and-SDKs/SDK-Documentation/basic-usage#treatment-variables)
are incredibly useful for setting particular values in your experiments, but
sometimes it can be useful to run code as a variable instead. This section
will show you a few examples of how this can be implemented; connecting your
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ context is ready.
One of the most useful and commonly used attributes, is the `user_agent` attribute
which, when passed to the SDK, will be split up into multiple attributes that
can be used to target specific browsers or devices in the Web Console. You can read
more about how this works in [the Segments section of the Dashboard Settings docs](/docs/web-console-docs/settings#segments).
more about how this works in [the Segments section of the Dashboard Settings docs](/docs/web-console-docs/configuration/settings#segments).

<Tabs groupId="language">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Events with custom assignments are **counted as eligible events** by the ABsmart
statistics engines. If you are using these methods for development purposes
(to force a particular variant for yourself or somebody else on the team) it is
likely that you need the
[`context.override` methods](/docs/SDK-Documentation/basic-usage#overriding-treatment-variants)
[`context.override` methods](/docs/APIs-and-SDKs/SDK-Documentation/basic-usage#overriding-treatment-variants)
instead.
:::

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Fields in Code

In the [Platform Settings on the Web Console](/docs/web-console-docs/settings#platform-settings), you can create
In the [Platform Settings on the Web Console](/docs/web-console-docs/configuration/settings#platform-settings), you can create
custom fields that are available to the SDKs. These custom fields can be used to add additional logic to your
A/B experiments.

Expand All @@ -18,7 +18,7 @@ Let's say you wish to override an experiment's allocation to a specific variant

### Creating a Custom Field

Checkout the [docs on creating a custom field](/docs/web-console-docs/settings#custom-fields) for more information on
Checkout the [docs on creating a custom field](/docs/web-console-docs/configuration/settings#custom-fields) for more information on
adding a field to your experiment creation form, but for this example, we'll create a field with
the following properties:
- **Name**: `Developers' variant`
Expand All @@ -31,7 +31,7 @@ the following properties:
- **Section**: `Description`

:::note
You may wish to [create a custom section](/docs/web-console-docs/settings#custom-fields) for this field.
You may wish to [create a custom section](/docs/web-console-docs/configuration/settings#custom-fields) for this field.
:::

### Using the Custom Field
Expand Down Expand Up @@ -64,7 +64,7 @@ edited on the Web Console to change the variant that developers see.

:::caution
Overriding an experiment allocation will not count the user towards the experiment data.
To learn more about overrides, have a look at the [overrides SDK documentation](/docs/SDK-Documentation/basic-usage#overriding-treatment-variants).
To learn more about overrides, have a look at the [overrides SDK documentation](/docs/APIs-and-SDKs/SDK-Documentation/basic-usage#overriding-treatment-variants).
:::

## Conclusion
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import FlutterOverriding from "!!raw-loader!./flutter/override.dart";
:::warning Warning
Overriden events are typed as ineligible and are **ignored** by the ABsmartly statistics engines.
If you want to force a particular experiment's variant and have the event be counted, you
can use the [`customAssignment` methods](/docs/SDK-Documentation/Advanced/custom-assignments)
can use the [`customAssignment` methods](/docs/APIs-and-SDKs/SDK-Documentation/Advanced/custom-assignments)
instead, although this **is not recommended**.
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ import FlutterImport from "!!raw-loader!./flutter/import.dart";
Once the SDK is installed, it can be initialized in your project.

:::info
The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/settings#api-keys),
an [Application](/docs/web-console-docs/tutorial#2-setting-your-applications), and an
[Environment](/docs/web-console-docs/settings#environments) have been created in the ABsmartly Web Console.
The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/configuration/settings#api-keys),
an [Application](/docs/web-console-docs/Configuration/Applications), and an
[Environment](/docs/web-console-docs/configuration/settings#environments) have been created in the ABsmartly Web Console.
Comment on lines +37 to +39
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Inconsistent path casing in documentation links.

The three updated reference links have inconsistent casing. Lines 37 and 39 use lowercase configuration while line 38 uses uppercase Configuration. This inconsistency is likely to result in broken links if the actual file paths don't match this mixed casing precisely. On Unix-like systems, file paths are case-sensitive, so /configuration/settings and /Configuration/Applications are treated as different paths.

Please verify that the actual file paths match these references exactly. Run the following verification:

Alternatively, standardise all paths to use consistent casing (typically lowercase is conventional for documentation structures):

- The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/configuration/settings#api-keys),
- an [Application](/docs/web-console-docs/Configuration/Applications), and an
- [Environment](/docs/web-console-docs/configuration/settings#environments) have been created in the ABsmartly Web Console.
+ The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/configuration/settings#api-keys),
+ an [Application](/docs/web-console-docs/configuration/applications), and an
+ [Environment](/docs/web-console-docs/configuration/settings#environments) have been created in the ABsmartly Web Console.

🏁 Script executed:

#!/bin/bash
# Description: Search for actual configuration and applications files in the docs directory
# to verify the correct casing of paths.

# Look for any files or directories with "configuration" or "applications" in their names
fd -i "configuration|applications" docs/web-console-docs --type f --type d

Length of output: 108


🏁 Script executed:

#!/bin/bash
# Find the actual file being reviewed and explore docs structure

echo "=== Looking for _import-and-initialize.mdx ==="
fd "_import-and-initialize" --type f

echo -e "\n=== Checking docs directory structure ==="
ls -la docs/ 2>/dev/null | head -20

echo -e "\n=== Searching for any configuration or applications related files ==="
fd -i "configuration|applications" --type f --type d 2>/dev/null | head -30

Length of output: 1069


🏁 Script executed:

#!/bin/bash
# Search for settings files and check the actual file content

echo "=== Looking for settings files ==="
fd -i "settings" docs/web-console-docs --type f

echo -e "\n=== Checking web-console-docs directory structure ==="
find docs/web-console-docs -maxdepth 2 -type f -o -type d | sort

echo -e "\n=== Actual content of lines 37-39 in the reviewed file ==="
sed -n '35,40p' docs/SDK-Documentation/getting-started/import-and-initialize/_import-and-initialize.mdx

Length of output: 2799


Broken documentation links due to incorrect path casing.

The review comment correctly identified a casing inconsistency, but this is more severe than stated: lines 37 and 39 contain broken links. The actual directory is Configuration (uppercase), not configuration (lowercase). Line 38 is correctly cased, but lines 37 and 39 will fail to resolve on case-sensitive systems.

All three links should use the correct casing to match the actual directory structure:

The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/Configuration/settings#api-keys),
an [Application](/docs/web-console-docs/Configuration/Applications), and an
[Environment](/docs/web-console-docs/Configuration/settings#environments) have been created in the ABsmartly Web Console.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/configuration/settings#api-keys),
an [Application](/docs/web-console-docs/Configuration/Applications), and an
[Environment](/docs/web-console-docs/configuration/settings#environments) have been created in the ABsmartly Web Console.
The following examples assume that an [Api Key with SDK permissions](/docs/web-console-docs/Configuration/settings#api-keys),
an [Application](/docs/web-console-docs/Configuration/Applications), and an
[Environment](/docs/web-console-docs/Configuration/settings#environments) have been created in the ABsmartly Web Console.
🤖 Prompt for AI Agents
In
docs/SDK-Documentation/getting-started/import-and-initialize/_import-and-initialize.mdx
around lines 37 to 39 the links on lines 37 and 39 use the wrong path casing
("configuration") which breaks on case-sensitive filesystems; update both links
to use the correct directory name "Configuration" (so they match the existing
line 38 and the actual repo structure) and verify the URLs resolve.

:::

<Tabs groupId="language">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,17 +191,17 @@ We are going to make sure our webhook is `Enabled` and `Ordered`; we will give i
and we will choose to send events whenever any experiment event occurs.

This includes:
- [ExperimentCreated](/docs/web-console-docs/settings#experiment-created)
- [ExperimentDevelopment](/docs/web-console-docs/settings#experiment-started-in-development)
- [ExperimentStarted](/docs/web-console-docs/settings#experiment-started)
- [ExperimentStopped](/docs/web-console-docs/settings#experiment-stopped)
- [ExperimentRestarted](/docs/web-console-docs/settings#experiment-restarted)
- [ExperimentFullOn](/docs/web-console-docs/settings#experiment-put-full-on)
- [ExperimentEdited](/docs/web-console-docs/settings#experiment-edited)
- [ExperimentCommented](/docs/web-console-docs/settings#experiment-commented-on)
- [ExperimentArchived](/docs/web-console-docs/settings#experiment-archived)
- [ExperimentUnarchived](/docs/web-console-docs/settings#experiment-unarchived)
- [ExperimentAlertCreated](/docs/web-console-docs/settings#experiment-alert-created)
- [ExperimentCreated](/docs/web-console-docs/configuration/settings#experiment-created)
- [ExperimentDevelopment](/docs/web-console-docs/configuration/settings#experiment-started-in-development)
- [ExperimentStarted](/docs/web-console-docs/configuration/settings#experiment-started)
- [ExperimentStopped](/docs/web-console-docs/configuration/settings#experiment-stopped)
- [ExperimentRestarted](/docs/web-console-docs/configuration/settings#experiment-restarted)
- [ExperimentFullOn](/docs/web-console-docs/configuration/settings#experiment-put-full-on)
- [ExperimentEdited](/docs/web-console-docs/configuration/settings#experiment-edited)
- [ExperimentCommented](/docs/web-console-docs/configuration/settings#experiment-commented-on)
- [ExperimentArchived](/docs/web-console-docs/configuration/settings#experiment-archived)
- [ExperimentUnarchived](/docs/web-console-docs/configuration/settings#experiment-unarchived)
- [ExperimentAlertCreated](/docs/web-console-docs/configuration/settings#experiment-alert-created)

Click `Create Webhook` and we should start receiving events in our express app!

Expand Down Expand Up @@ -246,7 +246,7 @@ app.listen(PORT, () => {

Now, whenever an experiment is changed or has an alert created, that event will be sent as a message to your Slack channel!

For further formatting of the messages, checkout the [various Webhook Payloads](/docs/web-console-docs/settings#payloads) that ABsmartly can send, and
For further formatting of the messages, checkout the [various Webhook Payloads](/docs/web-console-docs/configuration/settings#payloads) that ABsmartly can send, and
have a look at Slack's [Message Formatting](https://api.slack.com/messaging/composing) documentation.

Our final `index.ts` file should look like this:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 50,
"collapsible": true,
"collapsed": true,
"label": "Custom Integration Examples"
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"position": 4,
"collapsed": true,
"collapsible": true,
"label": "Web Console API"
"label": "Platform API"
}
6 changes: 6 additions & 0 deletions docs/APIs-and-SDKs/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 2,
"collapsible": true,
"collapsed": true,
"label": "APIs & SDKs"
}
18 changes: 18 additions & 0 deletions docs/APIs-and-SDKs/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 0
---

# Overview

The APIs & SDKs section provides everything you need to integrate ABsmartly into your product.
This is the technical foundation that powers experiment assignment, event tracking, feature flags and consistent user experiences across all platforms.

Here you will find:
- SDK documentation for client side, server side and mobile environments
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Hyphenate compound adjectives modifying nouns.

When "client side" and "server side" are used as compound adjectives, they should be hyphenated: "client-side" and "server-side".

Apply this diff to correct the compound adjectives:

-- SDK documentation for client side, server side and mobile environments  
+- SDK documentation for client-side, server-side and mobile environments
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- SDK documentation for client side, server side and mobile environments
- SDK documentation for client-side, server-side and mobile environments
🧰 Tools
🪛 LanguageTool

[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...d: - SDK documentation for client side, server side and mobile environments - API referen...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🤖 Prompt for AI Agents
In docs/APIs-and-SDKs/apis-and-sdks.mdx around line 11, the phrase "client side,
server side and mobile environments" uses unhyphenated compound adjectives;
change to "client-side, server-side, and mobile environments" by hyphenating
"client-side" and "server-side" and adding the serial comma for consistency.

- API references for the ABsmartly platform and the SDKs
- implementation guides, examples and best practices
- details on exposure handling, goal tracking and variant assignment

If you are an engineer integrating ABsmartly or maintaining experiment infrastructure, this section is for you.
It explains how the SDKs work, how to use the API programmatically and how to build a reliable experimentation setup that fits your architecture.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Image from '../../src/components/Image';
import Image from '../../../src/components/Image';

# SAML SSO - Azure

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Image from '../../src/components/Image';
import Image from '../../../src/components/Image';

# SAML SSO - Google Workspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Image from '../../src/components/Image';
import Image from '../../../src/components/Image';

# SAML SSO - Okta

Expand Down
6 changes: 6 additions & 0 deletions docs/Third-party-integrations/SSO/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 200,
"collapsed": true,
"collapsible": true,
"label": "SSO"
}
4 changes: 2 additions & 2 deletions docs/Third-party-integrations/Segment-Integration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ It can be useful to send experiment exposures to Segment for visibility from oth
By default, the _Track Calls_ mapping will filter and not send any events with the name `Experiment Viewed` to ABsmartly.
:::

You can [install a custom event logger](/docs/SDK-Documentation/getting-started#using-a-custom-event-logger) in ABsmartly and send exposures directly to Segment.
You can [install a custom event logger](/docs/APIs-and-SDKs/SDK-Documentation/getting-started#using-a-custom-event-logger) in ABsmartly and send exposures directly to Segment.

<CodeBlock language="javascript">{JsSendingExposuresToSegment}</CodeBlock>

Expand Down Expand Up @@ -256,7 +256,7 @@ To migrate from the classic ABsmartly destination to ABsmartly (Actions), discon
for this purpose.

In the ABsmartly context, we can
[install a custom event logger](https://docs.absmartly.com/docs/sdk-documentation/getting-started/#using-a-custom-event-logger)
[install a custom event logger](https://docs.absmartly.com/docs/APIs-and-SDKs/SDK-Documentation/getting-started/#using-a-custom-event-logger)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify that the absolute URL in the Segment integration docs resolves
curl -s -o /dev/null -w "%{http_code}" "https://docs.absmartly.com/docs/APIs-and-SDKs/SDK-Documentation/getting-started/#using-a-custom-event-logger"

Repository: absmartly/docs

Length of output: 61


URL returns 404 error — link is broken and must be fixed.

The absolute URL to the custom event logger documentation returns an HTTP 404 status code, indicating the endpoint does not exist or is not accessible. The path https://docs.absmartly.com/docs/APIs-and-SDKs/SDK-Documentation/getting-started/#using-a-custom-event-logger needs to be verified against the actual documentation structure before merging.

🤖 Prompt for AI Agents
In docs/Third-party-integrations/Segment-Integration/index.mdx around line 259
the absolute URL to the custom event logger returns a 404; verify the correct
target in the docs site and replace the broken absolute link with the correct
working URL or a relative path to the "using-a-custom-event-logger" section (or
remove the fragment if the anchor differs), then test the updated link to ensure
it resolves without 404 before merging.

and send exposures directly to Segment.

<CodeBlock language="javascript">{JsSendingExposuresToSegment}</CodeBlock>
Expand Down
8 changes: 6 additions & 2 deletions docs/Third-party-integrations/Zuko-Integration.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 3
---

import Image from "../../src/components/Image";

# Zuko Integration
Expand All @@ -15,7 +19,7 @@ Zuko to gain deeper insights into how your experiments affect your forms.
## Prerequisites

1. **ABsmartly Implementation:** Ensure ABsmartly is correctly implemented on your page. Refer
to the [SDK documentation](/docs/SDK-Documentation/getting-started) for more information.
to the [SDK documentation](/docs/APIs-and-SDKs/SDK-Documentation/getting-started) for more information.
2. **Zuko Account and Tracking:** [Create a Zuko account](https://app.zuko.io/signup) (if
you don't have one) and ensure that the tracking is successfully added to your form. Refer to
the [Zuko Installation Guides](https://www.zuko.io/guides) for more information.
Expand Down Expand Up @@ -61,7 +65,7 @@ attributes into `window.zuko.attributes`. See [Zuko's documentation on setting c
1. **Run your experiment:** Make sure your experiment is running on ABsmartly and users are being assigned to
different variants.
2. **Submit test forms:** Fill out the forms on your page while participating in the test. You can do this for
different variants using the ABsmartly SDKs' [override functionalities](/docs/SDK-Documentation/basic-usage#overriding-treatment-variants).
different variants using the ABsmartly SDKs' [override functionalities](/docs/APIs-and-SDKs/SDK-Documentation/basic-usage#overriding-treatment-variants).
3. **Check Zuko:** Go to your Zuko dashboard and look for the custom attributes you configured in the
filters dropdown. You should see attributes like `exp_YourExperimentName` with values corresponding
to the assigned variant for each form submission. It might take a few minutes for the data to appear in Zuko.
Expand Down
4 changes: 2 additions & 2 deletions docs/Third-party-integrations/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"position": 6,
"position": 3,
"collapsible": true,
"collapsed": true,
"label": "Third-party integrations"
"label": "Integrations"
}

72 changes: 72 additions & 0 deletions docs/get-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
sidebar_position: 0
---

# Get Started

Welcome to the ABsmartly Documentation.

ABsmartly is an advanced experimentation and feature flagging platform designed to help teams validate ideas quickly, measure impact reliably and roll out changes safely. The platform provides everything you need to design experiments, expose users consistently,
measure impact with robust metrics and make evidence based product decisions.

This documentation will guide you through how to use the platform, integrate it into your product and understand the core concepts behind trustworthy experimentation.
Comment on lines +7 to +12
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Address compound adjective hyphenation and missing comma.

A few minor grammar issues:

  • Line 10: "evidence based" should be "evidence-based" (compound adjective modifying a noun)
  • Line 12: Missing comma after "product" — should be "integrate it into your product, and understand"

Apply these corrections:

- measure impact with robust metrics and make evidence based product decisions.
+ measure impact with robust metrics and make evidence-based product decisions.

- This documentation will guide you through how to use the platform, integrate it into your product and understand the core concepts behind trustworthy experimentation.
+ This documentation will guide you through how to use the platform, integrate it into your product, and understand the core concepts behind trustworthy experimentation.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~10-~10: This expression is usually spelled with a hyphen.
Context: ...ure impact with robust metrics and make evidence based product decisions. This documentation ...

(BASED_HYPHEN)


[uncategorized] ~12-~12: Possible missing comma found.
Context: ...se the platform, integrate it into your product and understand the core concepts behind...

(AI_HYDRA_LEO_MISSING_COMMA)

🤖 Prompt for AI Agents
In docs/get-started.mdx around lines 7 to 12, fix two minor grammar issues:
change "evidence based" to the hyphenated compound adjective "evidence-based",
and insert a comma after "product" so the phrase reads "integrate it into your
product, and understand"; update the sentence accordingly to preserve original
meaning and punctuation.


---

## Documentation structure

The documentation is divided into a few main sections to help you find what you need easily.

### Product Documentation
This [section](./web-console-docs/overview) explains how to use the ABsmartly Web Console to run experiment and feature flags.

You will find guides on:
- [creating](./web-console-docs/experiments/creating-an-experiment) and managing experiments
- defining [goals](./web-console-docs/goals-and-metrics/goals/overview) and [metrics](./web-console-docs/goals-and-metrics/metrics/overview)
- using [feature flags](./web-console-docs/feature-flags/creating-a-feature)
- tracking [events](./web-console-docs/events/the-events-page)
- managing [users, teams and permissions](./web-console-docs/users-teams-permissions/teams)
- configuring workspaces and settings
- using the [LaunchPad browser extension](./web-console-docs/launchpad-browser-extension/getting-started)

If you use ABsmartly day to day to run experiments or feature flags, this is where you will spend most of your time.

---

### APIs & SDKs

This [section](./APIs-and-SDKs/overview) contains all technical resources for implementing ABsmartly in your product.

You will find:
- [SDK documentation](./APIs-and-SDKs/sdk-documentation/) for client side, server side and mobile
- [SDK API](./APIs-and-SDKs/SDK-API/absmartly-collector-api) references and examples
- The full platform [API reference](./APIs-and-SDKs/SDK-API/absmartly-collector-api) for programmatic access

Developers and engineers will spend most of their time here.

---

### Integrations
Using the platform API, ABsmartly can integrate with any tools you already use for analytics, communication and authentication.

This section includes from sample integration:
- [Slack integration](./Third-party-integrations/Slack-Integration)
- [Segment integration](./Third-party-integrations/Segment-Integration/)
- [Zuko integration](./Third-party-integrations/Zuko-Integration)
- [SSO setup](./Third-party-integrations/SSO/Azure%20SAML%20Setup)

Each guide explains how to connect ABsmartly with your existing systems.

---


## What to do next

If you are new to ABsmartly, we recommend starting with:
1. **Product Documentation → Getting Started**
2. **APIs & SDKs** (choose the SDK you need to integrate first)
3. **Experiments** to learn how to create, run and analyse your first test

You can explore the rest of the documentation as you become more familiar with the platform.

Welcome to ABsmartly.
Loading