-
Notifications
You must be signed in to change notification settings - Fork 0
New kb #238
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
base: development
Are you sure you want to change the base?
New kb #238
Changes from all commits
56b9b01
7099c41
e5e2bc6
e5f53b0
31466e1
c7a7cb0
60027b3
f63db26
a7a38d5
4652acd
c1ee9b3
e7fd912
beab2ab
15503a4
2c0f922
b6b4772
ed2df1c
0679491
f87bf62
0e96c17
17446cb
5b7d668
61a2602
8b5c6b7
9e6da3a
9d8bc63
7c52444
3f5a576
2b1aa2b
25bddf5
376f63f
f4d79ab
310ce40
236ef0a
b105666
53328da
f7be727
9fa4822
6499f30
b687ca6
b2c330f
a8cfa0e
a218fe4
ecde764
fe1cec9
aa29367
c2d221e
89b9fc8
c1451a5
efd6519
c1e261b
5323a13
0928cb9
9e30962
82248fa
c85a9fe
1eb13fc
61fc470
bf6c439
9e2fee9
f96a58d
bce7117
a483b34
3692c00
1c7f2a5
3b0ca10
67c603d
3672582
843d030
a8451a6
ac89e16
77cb2fd
194fbef
576a7d1
2931a43
bc3064c
d84d136
f60abb5
64e897e
1e2f850
bfa79b6
589186a
001eb33
63bb308
0e474b8
68af71b
2595d35
813cbd1
d0cc0b2
9b25f73
687fc9b
96dfd60
3e2b221
72f4d26
4eb651d
b6a2b4e
3970b1c
1289dc7
555d8bf
07ed473
e9fabf4
c10dc45
e97cfe9
928bb18
e601834
b0419ee
ca17fb8
037f4ab
1513fd4
082abdf
f4fd8bc
f3b7419
0b87a85
d51c6f8
643ef2f
302251c
b002def
7f549e1
1e01785
ff7587b
c6ca5e8
caa17f8
cb5f0c1
20dcdff
b9504c4
d834cf4
63bc474
5b837a2
beb009f
8b1d787
91a801b
7b2b083
740e83f
0038e05
7b95423
4db0644
3b84a77
6ce4923
9ab08a8
167293a
82a8cba
e3126c4
45fceed
2dc1bde
598296d
6afb560
5bf5b10
623bacf
c5c1229
a01e7fe
22995a5
fa02653
8b4dba2
0522cde
3939022
a5bbcd5
45798ae
50388d0
5dd74af
fe30b68
101116d
19585d6
53b6f93
10391d6
1906b01
7104e97
772239c
4307442
d51fef7
b30afb2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 |
|---|---|---|
|
|
@@ -2,5 +2,5 @@ | |
| "position": 4, | ||
| "collapsed": true, | ||
| "collapsible": true, | ||
| "label": "Web Console API" | ||
| "label": "Platform API" | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "position": 2, | ||
| "collapsible": true, | ||
| "collapsed": true, | ||
| "label": "APIs & SDKs" | ||
| } |
| 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 | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
Suggested change
🧰 Tools🪛 LanguageTool[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) 🤖 Prompt for AI Agents |
||||||
| - 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 |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "position": 200, | ||
| "collapsed": true, | ||
| "collapsible": true, | ||
| "label": "SSO" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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> | ||
|
|
||
|
|
@@ -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) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 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 🤖 Prompt for AI Agents |
||
| and send exposures directly to Segment. | ||
|
|
||
| <CodeBlock language="javascript">{JsSendingExposuresToSegment}</CodeBlock> | ||
|
|
||
| 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" | ||
| } | ||
|
|
| 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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Address compound adjective hyphenation and missing comma. A few minor grammar issues:
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. (BASED_HYPHEN) [uncategorized] ~12-~12: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) 🤖 Prompt for AI Agents |
||
|
|
||
| --- | ||
|
|
||
| ## 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. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Inconsistent path casing in documentation links.
The three updated reference links have inconsistent casing. Lines 37 and 39 use lowercase
configurationwhile line 38 uses uppercaseConfiguration. 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/settingsand/Configuration/Applicationsare 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):
🏁 Script executed:
Length of output: 108
🏁 Script executed:
Length of output: 1069
🏁 Script executed:
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), notconfiguration(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:
📝 Committable suggestion
🤖 Prompt for AI Agents