New kb #238
New kb #238
Conversation
chris-absmartly
requested review from
bmsilva,
calthejuggler,
marcio-absmartly and
mario-silva
as code owners
|
Important Review skippedToo many files! 144 files out of 294 files are above the max files limit of 150. You can disable this status message by setting the WalkthroughThis PR updates documentation and site metadata across the docs tree: many internal MDX links were rewritten to new paths (notably under /docs/APIs-and-SDKs/, /docs/web-console-docs/configuration/, and /docs/web-console-docs/experiments/), several platform release-note files had link fixes, relative import paths for the Image component were adjusted in multiple SSO SAML MDX files (moved up one directory level), multiple category.json entries were added or edited (labels, positions, collapsed/collapsible states), new top-level pages were added (docs/get-started.mdx, docs/APIs-and-SDKs/overview.mdx, docs/glossary.mdx), one MDX gained sidebar_position, and .gitignore patterns were updated to reflect reorganised documentation directories. No runtime application logic or exported code signatures were changed. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 27
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/SDK-Documentation/basic-usage/selecting-a-treatment/js/selectingATreatment.js (1)
17-24: Potential logic issue with truthy check.On line 20, using
if (variant)as a truthy check means that whenvariantequals0(the control group), the condition evaluates tofalse, and the control treatment code block would execute instead of the variant 1 code block. This is inconsistent with the promise-based example above, which explicitly checks for variants 1 and 2.For an A/B test where variant 0 is control and variant 1 is treatment, the current logic may be correct. However, for clarity and consistency with the previous example, consider using an explicit comparison.
If the intent is to handle multiple variants explicitly, apply this diff:
const variant = context.treatment("experiment_name"); - + // A/B Test - if (variant) { + if (variant === 1) { // insert code to show on variant 1 } else { // insert the control treatment code }Alternatively, if the truthy check is intentional (any non-zero variant is treatment), add a comment to clarify this behaviour.
docs/web-console-docs/Understanding-experimentation-metrics.mdx (1)
47-47: Fix typo in punctuation.Line 47 contains a typo: "measuring.=" should be "measuring."
Apply this diff:
-Those attributes describe the purpose of the metric, what it is measuring.= +Those attributes describe the purpose of the metric, what it is measuring.docs/web-console-docs/creating-an-experiment.mdx (1)
1-310: Correct case-sensitive link paths for two broken internal links.Two internal documentation links use incorrect casing that will break on case-sensitive filesystems:
- Line 122: Update
/docs/web-console-docs/understanding-experimentation-metricsto/docs/web-console-docs/Understanding-experimentation-metrics- Line 197: Update
/docs/web-console-docs/aborting-experimentsto/docs/web-console-docs/Aborting-experimentsThe target files exist with capitalised filenames and must match exactly for the links to resolve correctly.
🧹 Nitpick comments (15)
docs/web-console-docs/Aborting-experiments.mdx (1)
25-25: Consider adding a comma for clarity.The sentence would benefit from a comma before "but" to separate the two independent clauses more clearly.
Apply this diff:
-The benefit of GST is to allow for early stopping but only this can only happen if the experiment crossed a boundary at one of the planned interim analysis. +The benefit of GST is to allow for early stopping, but only this can only happen if the experiment crossed a boundary at one of the planned interim analysis.Note: This line also contains the redundant phrase "only this can only" which you may wish to simplify to "but this can only".
docs/platform-release-notes/2024/07.mdx (1)
13-14: Consider simplifying the phrasing.The phrase "have the ability to" could be simplified to "can" for more concise writing.
Apply this diff for a more concise phrasing:
-You now have the ability to assign permissions, allowing you to control +You can now assign permissions, allowing you to controldocs/platform-release-notes/2025/05.mdx (1)
27-27: Consider adding a comma for improved readability.Adding a comma after "As always" would enhance the sentence flow.
Apply this diff:
-As always we value your feedback so please share with us what you would like to see improve in the future. We have some really exciting new features coming your way in the next few releases so stay tuned. +As always, we value your feedback, so please share with us what you would like to see improve in the future. We have some really exciting new features coming your way in the next few releases, so stay tuned.docs/platform-release-notes/2025/04.mdx (1)
30-30: Consider adding commas for improved readability.Adding commas would enhance the sentence flow in the closing paragraph.
Apply this diff:
-As always we value your feedback so please share with us what you would like to see improve in the future. We have some really exciting new features coming your way in the next few releases so stay tuned. +As always, we value your feedback, so please share with us what you would like to see improve in the future. We have some really exciting new features coming your way in the next few releases, so stay tuned.docs/web-console-docs/types-of-analysis.mdx (1)
7-7: Minor: Maintain consistent English spelling throughout.The file mixes British spelling ("analyses") with American spellings elsewhere. Ensure consistency across the documentation—choose either "analyse/analyses" (British) or "analyze/analyses" (American) and apply uniformly.
Also applies to: 22-22
docs/platform-release-notes/2025/09.mdx (1)
5-5: Consider consistent use of British vs American English spelling across the documentation set.Line 5 uses "optimisations" (British English). Other files in this PR use "organize" and "initialize" (American English variants). Establish a clear spelling convention across all release notes and documentation.
docs/platform-release-notes/2025/07.mdx (1)
10-10: Hyphenate "up-to-date" for consistency and clarity.Line 10 uses "up to date" as a compound adjective. Hyphenation ("up-to-date") improves readability.
Apply this diff:
- Never miss a key event again. Our new built-in notification system ensures you're always up to date with what's happening on the platform. + Never miss a key event again. Our new built-in notification system ensures you're always up-to-date with what's happening on the platform.docs/platform-release-notes/2025/06.mdx (1)
10-10: Maintain spelling consistency across release notes.Line 10 uses "organisational" (British English). The PR contains mixed British and American English spellings. Adopt a single convention throughout.
Apply this diff to align with American English (used elsewhere):
- - This is the first step toward upcoming improvements around ownership, permissions, and team-level collaboration. Go to `Settings > Teams` to get started with managing your team and inviting your team members. If you already have teams defined in ABsmartly, you can simply move them to the right place in your org structure. Check our [wiki page](/docs/web-console-docs/creating-and-managing-teams) for more information on creating and managing teams in ABsmartly. + - This is the first step toward upcoming improvements around ownership, permissions, and team-level collaboration. Go to `Settings > Teams` to get started with managing your team and inviting your team members. If you already have teams defined in ABsmartly, you can simply move them to the right place in your organizational structure. Check our [wiki page](/docs/web-console-docs/creating-and-managing-teams) for more information on creating and managing teams in ABsmartly.docs/web-console-docs/Experiment-reports.mdx (1)
30-30: Rephrase "allows to toggle" for clarity.Line 30 uses the construction "allows to toggle" which is grammatically awkward in formal documentation. Consider using "allows toggling" or "provides the ability to toggle".
Apply this diff:
-The `Unique experiments` switch allows to toggle between reporting on **unique experiments** and reporting on **all iterations**. +The `Unique experiments` switch provides the ability to toggle between reporting on **unique experiments** and reporting on **all iterations**.docs/web-console-docs/ownership-and-permissions.mdx (1)
52-56: Vary sentence structure in team roles list.Lines 54–56 describe the three team roles, but each sentence begins with "The member" or similar repetition. Consider restructuring for better readability and flow.
Consider this alternative structure:
-Possible team roles are : -- **Team viewer**: The member will be able to list, view and comment on all assets owned by that team. -- **Team Contributor**: The member will be able to create new assets and edit, share all assets owned by that team. -- **Team Admin**: Same as Team Contributor + the member will be able to manage the team (add/remove members, edit metadata, etc). +Possible team roles are: +- **Team Viewer**: Ability to list, view, and comment on all assets owned by the team. +- **Team Contributor**: Can create new assets and edit/share all team-owned assets. +- **Team Admin**: All Team Contributor permissions plus team management (add/remove members, edit metadata, etc.).docs/web-console-docs/Events/downloading-events.mdx (1)
21-23: Add missing comma in compound sentence.Line 22 is part of a compound sentence that should have a comma before "When".
Apply this diff:
-- An export request is made a processed asynchronously. -- When the export file is ready a notification will show on the report's activity tab. +- An export request is made and processed asynchronously. +- When the export file is ready, a notification will show on the report's activity tab.Note: Line 21 also appears to need "and" instead of "a" ("made a processed").
docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx (1)
35-35: Add comma after introductory phrase.Line 35 should have a comma after "For example" as an introductory phrase.
Apply this diff:
-3. Enter your ABsmartly endpoint address. For example `https://demo-2.absmartly.com` +3. Enter your ABsmartly endpoint address. For example, `https://demo-2.absmartly.com`docs/platform-release-notes/2025/11.mdx (2)
16-20: Add missing punctuation in introductory and dependent clauses.Lines 16, 18, and 20 require commas after introductory phrases to improve clarity and adhere to grammatical conventions:
- While the Chrome Extension is still in Beta, we encourage you to give it a try and give us feedback. - Before you get started see our guides on [getting started with the LaunchPad]... + While the Chrome Extension is still in Beta, we encourage you to give it a try and give us feedback. + Before you get started, see our guides on [getting started with the LaunchPad]... - You can also watch this video where Jonas takes you through the process of creating a simple experiment. - This first release is only the first step as we have big plans for the **ABsmartly LaunchPad** in 2026. + You can also watch this video where Jonas takes you through the process of creating a simple experiment. + This first release is only the first step, as we have big plans for the **ABsmartly LaunchPad** in 2026.
39-42: Refine language in the ownership model explanation.The paragraph contains several style opportunities: repetitive sentence openings with "We", verbose phrasing with "a lot of", and inconsistent tense. Consider this revision for improved clarity and formality:
- We want to make things better and future-proof for you. We realise that we introduced a lot of changes but unless you take action on all the action items described above - then nothing should change (except for the Team Ownership which is now the default but which can be disabled in your settings) and you will be able to keep using the platform like you use it today. - When you are ready to start making use of the new functionalities, let us know and if you need help for example with some of the steps described above. + Our goal is to make things better and future-proof. We recognise that significant changes have been introduced, but nothing will change unless you act on the items above + (except for Team Ownership, now enabled by default but configurable in settings). You can continue using the platform as you do today. + When ready to use the new capabilities, please get in touch if you need assistance with any of the steps outlined above.docs/platform-release-notes/2024/04.mdx (1)
51-51: Correct possessive apostrophe in "owners' list".Line 51 uses "owners list" but should use the possessive form "owners' list" to indicate the list belonging to multiple owners.
- Add a policy to a role to limit web console users' visibility of - experiments to those in which they are part of the owners list. + Add a policy to a role to limit web console users' visibility of + experiments to those in which they are part of the owners' list.
|
|
||
| #### Include vs. exclude | ||
| - **Include rules** explicitly allow the experiment to run when conditions are matched. | ||
| - **Exclude rules** prevent the experiment from running when matched, even if an include would otherwise match. |
There was a problem hiding this comment.
Rephrase "an include" to improve grammar clarity.
Line 82 uses "even if an include would otherwise match", where "include" as a noun is non-standard. The phrasing should refer to the action or rule.
Apply this diff to fix:
- - **Exclude rules** prevent the experiment from running when matched, even if an include would otherwise match.
+ - **Exclude rules** prevent the experiment from running when matched, even if an include rule would otherwise match.📝 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.
| - **Exclude rules** prevent the experiment from running when matched, even if an include would otherwise match. | |
| - **Exclude rules** prevent the experiment from running when matched, even if an include rule would otherwise match. |
🧰 Tools
🪛 LanguageTool
[grammar] ~82-~82: The verb ‘include’ does not usually follow articles like ‘an’. Check that ‘include’ is spelled correctly; using ‘include’ as a noun may be non-standard.
Context: ...ment from running when matched, even if an include would otherwise match. #### Combining ...
(A_INFINITIVE)
🤖 Prompt for AI Agents
In docs/LaunchPad Browser
Extension/creating-an-experiment-with-the-launchpad.mdx around line 82, rephrase
the sentence to replace the non-standard noun "an include" with a clear
reference to the rule/action; update the line to read something like "**Exclude
rules** prevent the experiment from running when matched, even if an inclusion
rule would otherwise match." to improve grammar and clarity.
| 1. Review all experiment metadata and variant definitions. | ||
| 2. Click **Create Draft** to save a working version. | ||
| 3. Use **Preview Mode** to validate expected behavior. | ||
| 4. Finalise the setup on the web console (add metrics, etc) |
There was a problem hiding this comment.
Standardise British vs American English spelling.
Line 183 uses "Finalise" (British English), but the PR also uses "finalize" (American English) elsewhere. Maintain consistent spelling throughout the documentation set.
Apply this diff to align with American English (used elsewhere in the PR):
- 4. Finalise the setup on the web console (add metrics, etc)
+ 4. Finalize the setup on the web console (add metrics, etc)📝 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.
| 4. Finalise the setup on the web console (add metrics, etc) | |
| 4. Finalize the setup on the web console (add metrics, etc) |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~183-~183: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ...e** to validate expected behavior. 4. Finalise the setup on the web console (add metri...
(EN_WORD_COHERENCY)
🤖 Prompt for AI Agents
docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx
around line 183: the word "Finalise" uses British English while the PR uses
American English elsewhere; replace "Finalise" with "Finalize" on line 183 to
standardize spelling across the documentation.
| To make it possible for the ABsmartly SDK to applies the DOM changes to your website when the experiment is running, | ||
| you need to install the DOM Changes plugin and initialize it after your ABsmartly SDK context is ready. |
There was a problem hiding this comment.
Fix verb agreement in SDK plugin paragraph.
Line 47 has a grammatical error: "applies" should be "apply" (base form after "to").
Apply this diff:
-To make it possible for the ABsmartly SDK to applies the DOM changes to your website when the experiment is running,
+To make it possible for the ABsmartly SDK to apply the DOM changes to your website when the experiment is running,📝 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.
| To make it possible for the ABsmartly SDK to applies the DOM changes to your website when the experiment is running, | |
| you need to install the DOM Changes plugin and initialize it after your ABsmartly SDK context is ready. | |
| To make it possible for the ABsmartly SDK to apply the DOM changes to your website when the experiment is running, | |
| you need to install the DOM Changes plugin and initialize it after your ABsmartly SDK context is ready. |
🤖 Prompt for AI Agents
In docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx
around lines 47 to 48, the sentence uses incorrect verb agreement ("applies");
change "applies" to the base form "apply" so it reads "...for the ABsmartly SDK
to apply the DOM changes..." ensuring correct grammar.
|
|
||
| ## Maintenance Window | ||
|
|
||
| The upgrade is set for **Thursday, March 7th, from 10:00 AM to 12:00 PM**. |
There was a problem hiding this comment.
Correct date/day-of-week inconsistency.
March 7, 2025 was a Friday, not a Thursday. The maintenance window date should be corrected.
Apply this diff:
-The upgrade is set for **Thursday, March 7th, from 10:00 AM to 12:00 PM**.
+The upgrade is set for **Friday, March 7th, from 10:00 AM to 12:00 PM**.📝 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.
| The upgrade is set for **Thursday, March 7th, from 10:00 AM to 12:00 PM**. | |
| The upgrade is set for **Friday, March 7th, from 10:00 AM to 12:00 PM**. |
🧰 Tools
🪛 LanguageTool
[inconsistency] ~49-~49: Did you mean to refer to the current year? March 7th, 2025 is not a Thursday, but a Friday.
Context: ...enance Window The upgrade is set for Thursday, March 7th, from 10:00 AM to 12:00 PM. As with p...
(EN_DATE_WEEKDAY_CURRENTYEAR)
🤖 Prompt for AI Agents
In docs/platform-release-notes/2024/02.mdx around line 49, the maintenance
window text lists "Thursday, March 7th" which is the wrong day-of-week for March
7, 2025; update the line to use the correct weekday ("Friday") so it reads
"Friday, March 7th, from 10:00 AM to 12:00 PM." Ensure punctuation and
formatting (bold) remain unchanged.
| - We added up-to-date estimates of each interim analysis so you always | ||
| know when the next analysis will take place. | ||
| - We made it possible to set up a Group Sequential Test by simply using | ||
| a maximum runtime without the need for a MDE. |
There was a problem hiding this comment.
Use indefinite article "an" before MDE.
Line 15 should use "an" before the acronym MDE (which starts with a vowel sound).
Apply this diff:
- a maximum runtime without the need for a MDE.
+ a maximum runtime without the need for an MDE.📝 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.
| a maximum runtime without the need for a MDE. | |
| a maximum runtime without the need for an MDE. |
🧰 Tools
🪛 LanguageTool
[misspelling] ~15-~15: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... a maximum runtime without the need for a MDE. - We added a metric's performanc...
(EN_A_VS_AN)
🤖 Prompt for AI Agents
In docs/platform-release-notes/2024/12.mdx around line 15, the phrase uses "a
MDE" but should use the indefinite article "an" before the acronym MDE; update
the text to read "an MDE" at that location.
|
|
||
| ### Decision card | ||
|
|
||
| Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rational behind the decision and the key metrics supporting the decision. |
There was a problem hiding this comment.
Correct spelling: "rationale" instead of "rational".
Line 186 uses "rational" (meaning reasonable/logical), but the intended meaning is "rationale" (an explanation or reason).
Apply this diff:
-Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rational behind the decision and the key metrics supporting the decision.
+Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rationale behind the decision and the key metrics supporting the decision.📝 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.
| Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rational behind the decision and the key metrics supporting the decision. | |
| Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rationale behind the decision and the key metrics supporting the decision. |
🧰 Tools
🪛 LanguageTool
[misspelling] ~186-~186: Did you mean “rationale” (=an explanation / underlying reason)?
Context: ...sions, highlighting the hypothesis, the rational behind the decision and the key metrics...
(RATIONAL_RATIONALE)
🤖 Prompt for AI Agents
In docs/web-console-docs/Experiment-reports.mdx around line 186, the word
"rational" is used incorrectly; replace "rational" with "rationale" so the
sentence reads "...highlighting the hypothesis, the rationale behind the
decision and the key metrics supporting the decision."
| - **Positive Impact (Green)**: The confidence interval is entirely above 0, indicating a statistically significant improvement for the variant. | ||
| - **Negative Impact (Red)**: The confidence interval is entirely below 0, indicating a statistically significant negative effect. | ||
| - **Inconclusive (Grey)**: The confidence interval crosses 0, meaning the results are not statistically significant. | ||
| - **Insignificant (Grey)**: The confidence interval crosses 0, meaning the results are not statistically significant. |
There was a problem hiding this comment.
🧩 Analysis chain
Verify terminology change is consistent across documentation.
Line 35 changes "Inconclusive" to "Insignificant" for confidence interval interpretation. Ensure this terminology change is applied consistently throughout all documentation files to avoid confusion.
🏁 Script executed:
#!/bin/bash
# Search for remaining uses of "Inconclusive" vs "Insignificant" in docs
echo "=== Occurrences of 'Inconclusive' ==="
rg -i "inconclusive" docs/ --type mdx -n
echo -e "\n=== Occurrences of 'Insignificant' ==="
rg -i "insignificant" docs/ --type mdx -nLength of output: 133
---
🏁 Script executed:
```shell
#!/bin/bash
# Search for remaining uses of "Inconclusive" vs "Insignificant" in docs directory
echo "=== Occurrences of 'Inconclusive' in .mdx files ==="
rg -i "inconclusive" "docs/" --glob "*.mdx" -n
echo -e "\n=== Occurrences of 'Insignificant' in .mdx files ==="
rg -i "insignificant" "docs/" --glob "*.mdx" -n
echo -e "\n=== Total count of 'Inconclusive' ==="
rg -i "inconclusive" "docs/" --glob "*.mdx" -c | grep -c ":" || echo "0"
echo -e "\n=== Total count of 'Insignificant' ==="
rg -i "insignificant" "docs/" --glob "*.mdx" -c | grep -c ":" || echo "0"
Length of output: 2454
🏁 Script executed:
#!/bin/bash
# Also check the specific file mentioned in the review
echo "=== Content around line 35 of the target file ==="
cat "docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx" | head -50 | tail -20Length of output: 1376
Update terminology for consistency across documentation.
Verification confirms incomplete terminology migration. While line 35 now uses "Insignificant", the same file still contains "Inconclusive" in image alt text (lines 69, 87), and other documentation files retain "inconclusive" references:
- types-of-analysis.mdx (lines 41, 31)
- setting-up-a-gst-experiment.mdx (line 42)
- creating-an-experiment.mdx (line 310)
Apply the terminology change consistently throughout all documentation files to align with the deliberate rename documented in the release notes (2025/11.mdx line 54).
🤖 Prompt for AI Agents
In docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx (line
35) and also update the remaining occurrences referenced in this review —
docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx (lines 69,
87), docs/types-of-analysis.mdx (lines 31, 41),
docs/setting-up-a-gst-experiment.mdx (line 42), and
docs/creating-an-experiment.mdx (line 310) — replace the old term
"Inconclusive"/"inconclusive" (and any image alt text using it) with the new
consistent term "Insignificant"/"insignificant" preserving original
capitalization and context; ensure alt text and inline text are updated, run a
quick search across docs for any remaining instances, and update them to match
the release-note terminology.
| --- | ||
| ### Interpreting the Boundaries | ||
| 1. **Efficiency Boundary (Green)**: | ||
| 1. **Efficacy Boundary (Green)**: |
There was a problem hiding this comment.
🧩 Analysis chain
Verify boundary terminology update.
Line 100 changes "Efficiency Boundary" to "Efficacy Boundary" in the GST section. Confirm this terminology is correct and consistently applied in related documentation.
🏁 Script executed:
#!/bin/bash
# Search for boundary terminology
echo "=== Occurrences of 'Efficiency Boundary' ==="
rg "Efficiency Boundary" docs/ --type mdx -n
echo -e "\n=== Occurrences of 'Efficacy Boundary' ==="
rg "Efficacy Boundary" docs/ --type mdx -nLength of output: 144
🏁 Script executed:
#!/bin/bash
# Search for boundary terminology without type restriction
echo "=== Occurrences of 'Efficiency Boundary' ==="
rg "Efficiency Boundary" docs/ -n
echo -e "\n=== Occurrences of 'Efficacy Boundary' ==="
rg "Efficacy Boundary" docs/ -n
echo -e "\n=== Checking the specific file ==="
grep -n "Boundary" docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx | head -20Length of output: 318
🏁 Script executed:
#!/bin/bash
# First, explore directory structure
echo "=== Directory structure ==="
ls -la | head -20
echo -e "\n=== Finding mdx files ==="
find . -name "*.mdx" -type f 2>/dev/null | head -20
echo -e "\n=== Searching for 'Efficiency Boundary' ==="
rg "Efficiency Boundary" -n 2>/dev/null || echo "Not found"
echo -e "\n=== Searching for 'Efficacy Boundary' ==="
rg "Efficacy Boundary" -n 2>/dev/null || echo "Not found"
echo -e "\n=== Searching for boundary-related terms ==="
rg -i "boundary" . -n 2>/dev/null | grep -i "effic" | head -20Length of output: 3628
🏁 Script executed:
#!/bin/bash
# Get full context around the boundaries mentioned
echo "=== Lines 90-105 in Interpreting-metrics-in-experiment-results.mdx ==="
sed -n '90,105p' ./docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx
echo -e "\n=== Context in Aborting-experiments.mdx ==="
sed -n '20,35p' ./docs/web-console-docs/Aborting-experiments.mdx
echo -e "\n=== All boundary terminology in Interpreting-metrics ==="
grep -n -i "boundary" ./docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdxLength of output: 3328
Terminology inconsistency: "Efficacy" and "Efficiency" boundaries used interchangeably.
The change to line 100 introduces inconsistency rather than resolving it. The same document uses both "Efficiency Boundary" (line 94) and "Efficacy Boundary" (line 100) to describe the same concept. Related documentation in Aborting-experiments.mdx also references "efficiency boundary". Either line 94 must be updated to match line 100, or line 100 should revert to "Efficiency" for consistency.
🤖 Prompt for AI Agents
In docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx around
lines 94 to 100, the document uses both "Efficiency Boundary" (line 94) and
"Efficacy Boundary" (line 100) for the same concept; make terminology consistent
by changing line 100 from "Efficacy Boundary (Green):" to "Efficiency Boundary
(Green):" (or alternatively change line 94 to "Efficacy" if you prefer that
term) and update any nearby occurrences to match exactly, ensuring the same term
is used throughout related docs (including Aborting-experiments.mdx).
| - `conversion_rate` | ||
| - `click_through_rate` (ie: the percentage of users clicking on a link) | ||
| - `churn_rate` | ||
| -` email_open_rate` |
There was a problem hiding this comment.
Fix formatting inconsistency.
Line 83 has inconsistent backtick formatting: - email_open_rate`" should use consistent markdown list formatting.
Apply this diff:
-- `churn_rate`
--` email_open_rate`
+- `churn_rate`
+- `email_open_rate`Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/web-console-docs/Understanding-experimentation-metrics.mdx around line
83, the list item has inconsistent backtick/markdown formatting ("-`
email_open_rate`"); update the line to use consistent markdown list formatting
by making the dash followed by a space and wrapping the metric name in backticks
(e.g., - `email_open_rate`) so it matches surrounding list items.
| **Composite** metrics combine multiple individual metrics into one measure to capture a nuanced view of success. They are often used strategically but can dilute sensitivity. | ||
| Examples: | ||
| Overall Evaluation Criterion (OEC): Weighted combinations of metrics like engagement, revenue, and satisfaction | ||
| - `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction |
There was a problem hiding this comment.
Fix grammatical error.
The phrase "a weighted combinations" is grammatically incorrect. It should be either "a weighted combination" (singular) or "weighted combinations" (plural without article).
Apply this diff:
-- `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction
+- `Overall Evaluation Criterion` (OEC) as a weighted combination of metrics like engagement, revenue, and satisfaction📝 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.
| - `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction | |
| - `Overall Evaluation Criterion` (OEC) as a weighted combination of metrics like engagement, revenue, and satisfaction |
🧰 Tools
🪛 LanguageTool
[grammar] ~127-~127: The plural noun “combinations” cannot be used with the article “a”. Did you mean “a weighted combination” or “weighted combinations”?
Context: ...Overall Evaluation Criterion (OEC) as a weighted combinations of metrics like engagement, revenue, an...
(A_NNS)
🤖 Prompt for AI Agents
In docs/web-console-docs/Understanding-experimentation-metrics.mdx around line
127, fix the grammatical error in the phrase "a weighted combinations" by
changing it to "a weighted combination" (singular) so the sentence reads
"`Overall Evaluation Criterion` (OEC) as a weighted combination of metrics like
engagement, revenue, and satisfaction".
There was a problem hiding this comment.
Actionable comments posted: 9
♻️ Duplicate comments (28)
docs/Third-party-integrations/Zuko-Integration.mdx (1)
55-57: Spelling of "dropdown" has been flagged previously.This comment mirrors a previous review on this change. The term "drop down" should be spelled as a single word "dropdown" when used as an adjective. Please apply the suggested fix from the earlier review.
docs/SDK-Documentation/getting-started/install/swift/Podfile (1)
1-1: Critical: Incorrect pod name will cause installation failure.As flagged in the previous review, the pod name is incorrect. The ABSmartly Swift SDK is published to CocoaPods as
'absmartly', not'ABSmartlySwiftSDK'. This will causepod installto fail for users following the getting-started documentation.Apply this diff to correct the pod name:
-pod 'ABSmartlySwiftSDK' +pod 'absmartly'Additionally, once the pod name is corrected, verify that the latest version available on CocoaPods is stable and compatible with the getting-started documentation, as the version constraint has been removed.
docs/SDK-Documentation/basic-usage/peeking/python/peekAtVariables.py (1)
1-1: Fix indentation for valid Python syntax.The leading whitespace causes a syntax error. If this is intended as a standalone example, remove the indentation.
Apply this diff to fix the indentation:
- button_color = context.peek_variable("button.color", "red") +button_color = context.peek_variable("button.color", "red")If this snippet is meant to be embedded within a function or class, please ignore this comment.
docs/SDK-Documentation/basic-usage/peeking/js/peekAtVariant.js (1)
1-5: Use strict equality for type safety.The comparison uses loose equality (
==), which can lead to unexpected type coercion. Use strict equality (===) to ensure the variant is exactly0.Apply this diff:
-if (context.peek("exp_test_experiment") == 0) { +if (context.peek("exp_test_experiment") === 0) { // user is in control group (variant 0) } else { // user is in treatment group }docs/web-console-docs/Aborting-experiments.mdx (2)
55-55: Fix typo in Image component prop name.The prop
maxWidhshould bemaxWidth. This typo will prevent the image width constraint from being applied.-<Image img="experiment-dashboard/health-checks-audience-mismatch.png" alt="Audience mismatch warning" maxWidh="40rem" /> +<Image img="experiment-dashboard/health-checks-audience-mismatch.png" alt="Audience mismatch warning" maxWidth="40rem" />
17-17: Fix grammar error: use singular "decision"."A decisions" is grammatically incorrect and should be "a decision".
-Aborting a fixed-horizon experiment means making a decisions (usually to stop) before the experiment has collected the required sample size. +Aborting a fixed-horizon experiment means making a decision (usually to stop) before the experiment has collected the required sample size.docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx (2)
183-183: Standardise spelling: use American English "Finalize".The PR uses American English "finalize" elsewhere. Update line 183 to maintain consistency.
-4. Finalise the setup on the web console (add metrics, etc) +4. Finalize the setup on the web console (add metrics, etc)
82-82: Fix grammar: use "include rule" not just "include".The noun phrase "an include" is non-standard. Use "an include rule" to clarify the reference.
- - **Exclude rules** prevent the experiment from running when matched, even if an include would otherwise match. + - **Exclude rules** prevent the experiment from running when matched, even if an include rule would otherwise match.docs/platform-release-notes/2025/04.mdx (1)
23-23: Fix formatting error: remove trailing asterisk.Line 23 ends with a double asterisk that breaks Markdown formatting. The sentence should end with a single period inside the bold markup.
- **Secondary & Guardrail metrics:** Like with the primary metric, you can now see the experiment results on the secondary and guardrail metrics. This helps understand the rationale behind each decision.** + **Secondary & Guardrail metrics:** Like with the primary metric, you can now see the experiment results on the secondary and guardrail metrics. This helps understand the rationale behind each decision.docs/web-console-docs/Experiment-reports.mdx (3)
135-137: ** Fix grammar agreement errors on lines 135–137.**This issue was previously flagged. The text still contains two grammatical errors:
- Line 135: "A Full on decisions means" — should use the singular "decision"
- Line 136: "when an experiments is completed" — should use the singular "experiment" with "is"
Apply this diff:
- This widget provides a view on how many `Full on` decisions were made in the reporting period. A Full on decisions means that the tested change was - fully rolled out. `Full on` decisions are typically made when an experiments is completed and the evidence supports the decision (ie: the primary metrics shows an increase in the expected direction, no red flag, no health checks violation, etc). + This widget provides a view on how many `Full on` decisions were made in the reporting period. A Full on decision means that the tested change was + fully rolled out. `Full on` decisions are typically made when an experiment is completed and the evidence supports the decision (ie: the primary metric shows an increase in the expected direction, no red flag, no health check violations, etc).
143-143: ** Fix auxiliary verb agreement on line 143.**This issue was previously flagged. The auxiliary verb form is incorrect: "does not currently includes" should use the base form "include".
Apply this diff:
- The supported by evidence validation does not currently includes checks on the secondary and guardrail metrics nor on the experiment [health checks](/docs/web-console-docs/experiment-health-checks). + The supported by evidence validation does not currently include checks on the secondary and guardrail metrics nor on the experiment [health checks](/docs/web-console-docs/experiment-health-checks).
186-186: ** Correct spelling: "rationale" instead of "rational" on line 186.**This issue was previously flagged. "Rational" (adjective meaning reasonable) is incorrect; the intended meaning is "rationale" (noun meaning explanation/reason).
Apply this diff:
- Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rational behind the decision and the key metrics supporting the decision. + Each decision card provides an overview of the past decisions, highlighting the hypothesis, the rationale behind the decision and the key metrics supporting the decision.docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx (1)
47-48: ** Fix verb agreement: "applies" should be "apply" on line 47.**This issue was previously flagged. The infinitive after "to" requires the base form of the verb.
Apply this diff:
- To make it possible for the ABsmartly SDK to applies the DOM changes to your website when the experiment is running, + To make it possible for the ABsmartly SDK to apply the DOM changes to your website when the experiment is running,docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx (2)
69-69: ** Update image alt text to use "Insignificant" for consistency.**This terminology consistency issue was previously flagged. Lines 69 and 87 use "Inconclusive" in alt text, but the main content (line 35) was changed to "Insignificant". Update these alt texts for consistency.
Apply this diff:
- <Image img="experiment-results/gst-inconclusive-result.png" alt="Inconclusive GST result in ABsmartly" maxWidth="45rem" /> + <Image img="experiment-results/gst-insignificant-result.png" alt="Insignificant GST result in ABsmartly" maxWidth="45rem" />Apply the same change to line 87.
Also applies to: 87-87
94-100: ** Resolve boundary terminology inconsistency.**This issue was previously flagged. The document uses both "Efficiency Boundary" (line 94) and "Efficacy Boundary" (line 100) to describe what should be the same concept. Choose one consistent term throughout. The heading on line 100 uses "Efficacy Boundary", but the earlier explanation on line 94 uses "Efficiency Boundary".
Recommended: Update line 94 to use "Efficacy Boundary" to match the section heading on line 100.
Apply this diff:
- - **Efficiency Boundary (Green Region)**: The upper boundary. If the Z-Score trajectory crosses this boundary, the variant shows a statistically significant improvement, and the experiment can be stopped early for success. + - **Efficacy Boundary (Green Region)**: The upper boundary. If the Z-Score trajectory crosses this boundary, the variant shows a statistically significant improvement, and the experiment can be stopped early for success.docs/web-console-docs/Events/goal-events.mdx (1)
28-29: Fix unresolved typo from previous review.Line 28 contains the typo "enrish" (previously flagged in a prior review). The correct spelling is "enrich". This issue should have been corrected before resubmission.
-Before sending goal events, make sure to correctly initialise the ABsmartly's context and enrish it with the visitor's attributes. +Before sending goal events, make sure to correctly initialise the ABsmartly's context and enrich it with the visitor's attributes.docs/web-console-docs/Understanding-experimentation-metrics.mdx (2)
83-83: Fix unresolved formatting inconsistency from previous review.Line 83 still has incorrect backtick/markdown formatting (previously flagged). The list item should maintain consistent spacing: the backtick should immediately follow the code formatting symbol, with a space after the dash.
--` email_open_rate` +- `email_open_rate`
127-127: Fix unresolved grammatical error from previous review.Line 127 contains a grammatical error (previously flagged). The phrase "a weighted combinations" is incorrect; the plural noun "combinations" cannot be used with the singular article "a". Use the singular form instead.
-- `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction +- `Overall Evaluation Criterion` (OEC) as a weighted combination of metrics like engagement, revenue, and satisfactiondocs/web-console-docs/Experiment-health-checks.mdx (1)
53-53: Fix unresolved punctuation from previous review.Line 53 is missing a comma after the introductory phrase "For example" (previously flagged in a prior review). This should have been corrected before resubmission. Standard English grammar requires a comma after "For example" when introducing an example.
-An expected 50/50 split in a two-variant experiment shows significant deviations between variants. For example 1000 participants are in variant A and 1200 participants in variant B. +An expected 50/50 split in a two-variant experiment shows significant deviations between variants. For example, 1000 participants are in variant A and 1200 participants in variant B.docs/platform-release-notes/2024/02.mdx (1)
49-49: Correct day-of-week for maintenance window date.March 7, 2025 is a Friday, not a Thursday. Correct the maintenance window text to reflect the accurate day of the week.
-The upgrade is set for **Thursday, March 7th, from 10:00 AM to 12:00 PM**. +The upgrade is set for **Friday, March 7th, from 10:00 AM to 12:00 PM**.docs/web-console-docs/Events/downloading-events.mdx (1)
25-27: Fix typos in note admonition.Line 26 contains two typos: "us" should be "is", and "as" should be "has". These affect clarity and must be corrected.
:::Note -The link to download the file us only valid for 30 days. A new request can be made if the link as expired. +The link to download the file is only valid for 30 days. A new request can be made if the link has expired. :::docs/web-console-docs/Events/exposure-events.mdx (2)
36-36: Fix spelling and typo in context preparation note.Line 36 contains a British English spelling variant ("initialise") and a typo ("enrish"). Standardise to American English and correct the typo:
-Before sending exposure events, make sure to correctly initialise and enrish the ABsmartly's context with the [visitor's identity](visitors-identity). +Before sending exposure events, make sure to correctly initialize and enrich the ABsmartly's context with the [visitor's identity](visitors-identity).
101-101: Add comma after introductory phrase in table.Line 101 (table cell) is missing a comma after the introductory phrase "In this case".
-| **event_type** | This indicates the sort of event. In this case `exposure`. | +| **event_type** | This indicates the sort of event. In this case, `exposure`. |docs/web-console-docs/Events/visitors-identity.mdx (3)
9-12: Fix grammar and spelling errors in opening section.Lines 9 and 12 contain multiple errors that must be corrected:
- Line 9: "is uses" should be "is used"
- Line 12: "Identify" should be "Identity", and "enrish" should be "enrich"
-The Visitors Identity is uses to uniquely identify and track visitors over time and across your products. +The Visitors Identity is used to uniquely identify and track visitors over time and across your products. There are 2 parts to it, the unique identifiers and the attributes. -The Visitors Identify is used by the SDKs to create and enrish the experimentation context from which exposure and goals events can be triggered. +The Visitors Identity is used by the SDKs to create and enrich the experimentation context from which exposure and goals events can be triggered.
40-43: Fix plural agreement and possessive pronoun errors.Lines 41–42 contain errors in number agreement and pronoun usage that affect clarity:
- Line 41: "variant" should be plural "variants"
- Line 42: "they clear they cookies" should be "they clear their cookies"
-Others like `anonymous_id` are much more transient. This means that the same physical person could potentially have several `anonymous_id` (and as a result see different variant of your experiment). -This is the case for example when they use several devices or if they clear they cookies between different sessions. +Others like `anonymous_id` are much more transient. This means that the same physical person could potentially have several `anonymous_id` (and as a result see different variants of your experiment). +This is the case for example when they use several devices or if they clear their cookies between different sessions.
50-51: Fix plural and spelling errors in Attributes section.Line 50 contains a plural agreement error and a typo:
- "Attribute" should be "Attributes"
- "enrish" should be "enrich"
-Visitors Attribute are used to enrish the ABsmartly context with any information you might have about this visitor, +Visitors Attributes are used to enrich the ABsmartly context with any information you might have about this visitor,docs/platform-release-notes/2024/12.mdx (2)
38-43: BLOCKER: Resolve unresolved merge conflict.There is an unresolved git merge conflict in the "Default platform settings" section. The conflict must be resolved before this PR can be merged. The correct variant should use "or" (not "of") and the path should be
types-of-analysis(plural):- Choose which analysis type -<<<<<<< HEAD - ([Group Sequential or Fixed Horizon](/docs/web-console-docs/types-of-analysis)) -======= - ([Group Sequential of Fixed Horizon](/docs/web-console-docs/type-of-analysis)) ->>>>>>> 366dab8 (feat: add release notes section) - is the default for all new experiments. + Choose which analysis type + ([Group Sequential or Fixed Horizon](/docs/web-console-docs/types-of-analysis)) + is the default for all new experiments.
15-15: Use indefinite article "an" before acronym MDE.Line 15 should use "an" before the acronym MDE (which starts with a vowel sound):
- a maximum runtime without the need for a MDE. + a maximum runtime without the need for an MDE.
🧹 Nitpick comments (19)
docs/platform-release-notes/2025/06.mdx (1)
31-31: Add a comma after "in progress" for clarity.Line 31 would benefit from a comma to separate the introductory clause from the main statement.
Apply this diff:
- You will get a confirmation that the request is in progress. The process might take a while depending on the size of the experiment. + You will get a confirmation that the request is in progress. The process might take a while, depending on the size of the experiment.docs/platform-release-notes/2025/03.mdx (1)
46-46: Add a comma before "but like" to clarify the compound sentence.For better readability when connecting independent clauses with "but", add a comma.
Apply this diff:
- - **What's next?** We are already working on some improvements but like - + **What's next?** We are already working on some improvements, but likedocs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx (1)
35-35: Add a comma after "For example" for proper punctuation.When "For example" introduces an example, it should be followed by a comma.
Apply this diff:
- 3. Enter your ABsmartly endpoint address. For example `https://demo-2.absmartly.com` + 3. Enter your ABsmartly endpoint address. For example, `https://demo-2.absmartly.com`docs/web-console-docs/types-of-analysis.mdx (1)
22-22: Address word-variant inconsistency in "analyses" and "analyze".The passage mixes British English ("interim analyses") with American English ("analyze"). Choose one variant consistently throughout the documentation. If the codebase standardises on American English, change "analyses" to "analyzes".
Apply this diff to standardise to American English:
-[Group Sequential Testing](https://absmartly.com/gst) is an adaptive analysis method that allows for interim analyses at various points during the experiment. +[Group Sequential Testing](https://absmartly.com/gst) is an adaptive analysis method that allows for interim analyzes at various points during the experiment.Alternatively, if the codebase uses British English, change "analyze" in line 31 and elsewhere to "analyse".
docs/platform-release-notes/2024/05.mdx (1)
40-40: Date format note: LanguageTool false positive.LanguageTool flags the maintenance window date as a weekday mismatch, but this is a false positive. The file documents May 2024 releases, so the date "Thursday, May 23rd" correctly refers to 23 May 2024 (which was indeed a Thursday). The linter incorrectly checks against the current year (2025).
For extra clarity, consider optionally adding the year:
-This upgrade is scheduled for **Thursday, May 23rd, between 2:00 PM and 4:00 PM GMT**. +This upgrade is scheduled for **Thursday, May 23rd, 2024, between 2:00 PM and 4:00 PM GMT**.However, given the file path structure (
2024/05.mdx), the current format is acceptable.docs/platform-release-notes/2024/01.mdx (1)
42-42: Date format note: LanguageTool false positives.LanguageTool flags both maintenance window dates as weekday mismatches, but these are false positives. The file documents January/February 2024 releases, so:
- "Thursday, February 1st" correctly refers to 1 February 2024 (which was indeed a Thursday)
- "Thursday, February 8th" correctly refers to 8 February 2024 (which was indeed a Thursday)
The linter incorrectly checks against the current year (2025). For clarity, consider optionally adding the year:
-**Thursday, February 1st, from 10:00 AM to 12:00 PM**. +**Thursday, February 1st, 2024, from 10:00 AM to 12:00 PM**. -**Thursday, February 8th, from 10:00 AM to 12:00 PM**. +**Thursday, February 8th, 2024, from 10:00 AM to 12:00 PM**.However, given the file path structure (
2024/01.mdx), the current format is acceptable.Also applies to: 46-46
docs/web-console-docs/setting-up-a-fixed-horizon-experiment.mdx (2)
14-14: Add comma to clarify the sentence structure.The sentence connecting two independent clauses ("you are selecting" and "check our") needs a comma for clarity:
-To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article](/docs/web-console-docs/types-of-analysis). +To understand the differences between Group Sequential and Fixed Horizon experiments, check our [analysis type article](/docs/web-console-docs/types-of-analysis).Also note: "experiment" should be plural ("experiments") to match the plural form in the types-of-analysis.mdx heading.
72-74: Reworded metrics graph description improves clarity.The revised text on line 72–74 now clearly explains that:
- A button shows the metrics performance graph (when data is available)
- The underlying query samples 10% of visitors for performance reasons
This additional context is helpful for users understanding the graph's scope and limitations. Add a comma for grammatical clarity on line 72:
-If the metric you are selecting is not new and we have already collected data for it, you will see a button to show the metrics performance graph. +If the metric you are selecting is not new, and we have already collected data for it, you will see a button to show the metrics performance graph.docs/platform-release-notes/2024/07.mdx (1)
13-13: Simplify phrasing for conciseness.Replace the phrase "have the ability to" with the more direct and concise "can":
-You now have the ability to assign permissions, allowing you to control +You can now assign permissions, allowing you to controlThis improves readability and maintains the same meaning.
docs/web-console-docs/Events/the-events-page.mdx (2)
34-35: Add missing comma before 'and' in compound sentence.Line 34 connects two independent clauses with 'and'. For clarity and grammatical correctness, a comma should precede the conjunction.
-[Goal events](goal-events) are sent by the SDKs when the `track` function is called and they +[Goal events](goal-events) are sent by the SDKs when the `track` function is called, and they include any properties that were passed along with it.
52-53: Add missing comma after introductory phrase.Line 52 requires a comma following the introductory phrase "For debugging" to improve readability.
-For debugging it can be useful to filter the incoming events to narrow them +For debugging, it can be useful to filter the incoming events to narrow themdocs/platform-release-notes/2025/07.mdx (1)
10-10: Hyphenate compound adjective 'up-to-date'.Line 10 uses "up to date" as a compound adjective; it should be hyphenated for consistency with standard English grammar.
-Never miss a key event again. Our new built-in notification system ensures you're always up to date with what's happening on the platform. +Never miss a key event again. Our new built-in notification system ensures you're always up-to-date with what's happening on the platform.docs/web-console-docs/Experiment-health-checks.mdx (1)
64-64: Fix grammatical error: preposition and article usage.Line 64 should clarify the sense: "Including the wrong audience can dilute..." is unclear. Consider: "Allowing the wrong audience..." or restructure for clarity. The phrase "It means that a non-intended audience is being exposed to your changes. Including the wrong audience..." lacks a clear antecedent or transition.
-It means that a non-intended audience is being exposed to your changes.Including the wrong audience can dilute the experiment's impact and obscure meaningful insights. +It means that a non-intended audience is being exposed to your changes. Allowing the wrong audience can dilute the experiment's impact and obscure meaningful insights.docs/web-console-docs/ownership-and-permissions.mdx (1)
9-10: Simplify opening by reducing "make use of" repetition.Lines 9-10 use "make use of" twice in consecutive sentences. Consider rephrasing for better variety:
-In this document we will discuss those changes and how you can start making use of them. +In this document, we will explore these changes and how to implement them.docs/platform-release-notes/2025/11.mdx (2)
14-20: Improve sentence flow and punctuation in the LaunchPad Beta section.Lines 14–20 need better punctuation and connectors. Current sentences read disjointly:
- Line 14 ends without proper punctuation before the next statement
- Line 16 lacks a comma after "Before you get started"
- Line 18 needs comma placement to connect with the following sentence
- Line 20 needs a comma before "as we have big plans"
These adjustments will improve readability and flow. Consider revising to:
- While the Chrome Extension is still in Beta, we encourage you to give it a try and give us feedback. - Before you get started see our guides on [getting started with the LaunchPad]... and [creating your first experiment](...). - You can also watch this video where Jonas takes you through the process of creating a simple experiment. - This first release is only the first step as we have big plans for the **ABsmartly LaunchPad** in 2026. + While the Chrome Extension is still in Beta, we encourage you to give it a try and share your feedback. + Before you get started, see our guides on [getting started with the LaunchPad]... and [creating your first experiment](...). + You can also watch this video where Jonas walks you through the process of creating a simple experiment. + This first release is only the first step; we have big plans for the **ABsmartly LaunchPad** in 2026.
39-40: Simplify the clause structure in the Ownership & Permissions section (lines 39–40).The sentence logic is correct but the phrasing is confusing: "We realise that we introduced a lot of changes but unless you take action on all the action items described above then nothing should change..."
This double-negative structure ("unless... nothing should") makes the meaning harder to parse quickly. Consider a direct rewrite:
- We realise that we introduced a lot of changes but unless you take action on all the action items described above then nothing should change (except for the Team Ownership which is now the default but which can be disabled in your settings) and you will be able to keep using the platform like you use it today. + We've introduced several changes, but you have full control: unless you take action on the items above, nothing will change—except Team Ownership, which is now the default (but can be disabled in settings). This means you can continue using the platform as before until you're ready to adopt the new features.docs/platform-release-notes/2024/04.mdx (1)
50-52: Minor: Refine possessive noun form on line 51."ownership of that asset" is clear, but "owners list" on line 51 is slightly informal. Consider the more precise plural possessive: "owners' list". However, this is optional.
- Add a policy to a role to limit web console users' visibility of experiments to those in which they are part of the owners list. + Add a policy to a role to limit web console users' visibility of experiments to those in which they are part of the owners' list.docs/web-console-docs/creating-an-experiment.mdx (2)
15-17: Add comma after introductory clause (line 15)."Instead of creating an experiment from scratch" is an introductory phrase and requires a comma for clarity:
- Instead of creating an experiment from scratch you can also decide to use a pre-existing template. + Instead of creating an experiment from scratch, you can also decide to use a pre-existing template.
125-126: Reword line 125 for grammatical clarity: use "whether" instead of "if".In conditional/uncertain contexts with alternatives, "whether" is more precise than "if":
- This is the metric which ABsmartly uses to compute the test statistics and it is the main metric which will be used to decide if the hypothesis is tested or not. + This is the metric which ABsmartly uses to compute the test statistics and it is the main metric which will be used to decide whether the hypothesis is tested or not.Also add a comma before "and" to separate two independent clauses.
| if (this.$absmartly.peek("exp_test_experiment") == 0) { | ||
| // user is in control group (variant 0) | ||
| } else { | ||
| // user is in treatment group | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Use strict equality for type safety.
The comparison uses loose equality (==), which can lead to unexpected type coercion in JavaScript. Use strict equality (===) to ensure the variant is exactly 0.
Apply this diff:
-if (this.$absmartly.peek("exp_test_experiment") == 0) {
+if (this.$absmartly.peek("exp_test_experiment") === 0) {
// user is in control group (variant 0)
} else {
// user is in treatment group
}🤖 Prompt for AI Agents
In docs/SDK-Documentation/basic-usage/peeking/vue/peekAtVariant.js around lines
1 to 5, the code uses loose equality (==) when comparing the returned variant to
0; change the comparison to strict equality (===) so the check only succeeds for
the numeric variant 0 (i.e., replace == with === in the if condition).
| 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. | ||
| If you have any issues setting up the Zuko integration then please contact us on [support@absmartly.com](mailto:support@absmartly.com), |
There was a problem hiding this comment.
Add a comma after "integration then".
Per standard English punctuation rules for "if–then" constructions, a comma should be inserted between the conditional clause and the main clause.
Apply this diff:
-If you have any issues setting up the Zuko integration then please contact us on [support@absmartly.com](mailto:support@absmartly.com),
+If you have any issues setting up the Zuko integration, then please contact us on [support@absmartly.com](mailto:support@absmartly.com),📝 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.
| If you have any issues setting up the Zuko integration then please contact us on [support@absmartly.com](mailto:support@absmartly.com), | |
| If you have any issues setting up the Zuko integration, then please contact us on [support@absmartly.com](mailto:support@absmartly.com), |
🧰 Tools
🪛 LanguageTool
[style] ~69-~69: Consider an alternative verb to strengthen your wording.
Context: ...for the data to appear in Zuko. If you have any issues setting up the Zuko integrat...
(IF_YOU_HAVE_THIS_PROBLEM)
[typographical] ~69-~69: Consider adding a comma.
Context: ...y issues setting up the Zuko integration then please contact us on [support@absmartly...
(IF_THEN_COMMA)
🤖 Prompt for AI Agents
In docs/Third-party-integrations/Zuko-Integration.mdx around line 69, the
sentence "If you have any issues setting up the Zuko integration then please
contact us on [support@absmartly.com](mailto:support@absmartly.com)," is missing
a comma after the conditional clause; insert a comma after "then" (or better:
"integration, then please contact us...") so the sentence reads with proper
punctuation.
| ## Aborting Group Sequential experiments | ||
|
|
||
| **Group Sequential Test (GST)** are designed for interim analyses, providing valid statistical checks that allow for early-stopping experiments when appropriate. | ||
| The benefit of GST is to allow for early stopping but only this can only happen if the experiment crossed a boundary at one of the planned interim analysis. |
There was a problem hiding this comment.
Fix awkward phrasing: remove duplicate word "only".
Line 25 contains the phrase "but only this can only happen if", which is awkward and repetitive. Simplify this.
-The benefit of GST is to allow for early stopping but only this can only happen if the experiment crossed a boundary at one of the planned interim analysis.
+The benefit of GST is to allow for early stopping, but this can only happen if the experiment crossed a boundary at one of the planned interim analyses.📝 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.
| The benefit of GST is to allow for early stopping but only this can only happen if the experiment crossed a boundary at one of the planned interim analysis. | |
| The benefit of GST is to allow for early stopping, but this can only happen if the experiment crossed a boundary at one of the planned interim analyses. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...it of GST is to allow for early stopping but only this can only happen if the experi...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~25-~25: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...ow for early stopping but only this can only happen if the experiment crossed a boun...
(ADVERB_REPETITION_PREMIUM)
🤖 Prompt for AI Agents
In docs/web-console-docs/Aborting-experiments.mdx around line 25, the sentence
contains a duplicated "only" ("but only this can only happen if"); edit the
sentence to remove the redundant word so it reads clearly (e.g., "but this can
only happen if" or "but only if"), ensuring grammar and intended meaning are
preserved.
| How about we start creating some experiments? At the top of the dashboard, you | ||
| will find the **New Experiment** button. Here you will be able to fine tune, | ||
| edit and start your experiment. | ||
| A step by step guide to creating a new experiment in ABsmartly. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Fix hyphenation in compound adjectives and noun modifiers.
Several compound terms require hyphens per English grammar rules:
- Line 9: "step by step" → "step-by-step" (compound adjective)
- Line 39: "human readable" → "human-readable" (compound adjective)
- Line 64: "set up" (used as noun phrase) → "set-up" (noun)
- Line 201: "decision making" (noun) → "decision-making" (noun)
- A step by step guide to creating a new experiment in ABsmartly.
+ A step-by-step guide to creating a new experiment in ABsmartly.
- As this name will be used to identify your experiment in ABsmartly, we recommend using a good human readable name.
+ As this name will be used to identify your experiment in ABsmartly, we recommend using a good human-readable name.
- The optimal set up is an A/B experiment with a 50/50 split in traffic.
+ The optimal set-up is an A/B experiment with a 50/50 split in traffic.
- **Exploratory Metrics** are simply used for curiosity. They should have no impact on the decision making process.
+ **Exploratory Metrics** are simply used for curiosity. They should have no impact on the decision-making process.Also applies to: 39-39, 64-64, 201-201
🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: Did you mean the adjective or adverb “step-by-step” (spelled with hyphens)?
Context: ...ts/Image"; # Creating an experiment A step by step guide to creating a new experiment in A...
(STEP_BY_STEP_HYPHEN)
🤖 Prompt for AI Agents
In docs/web-console-docs/creating-an-experiment.mdx around lines 9, 39, 64 and
201, fix compound-word hyphenation: change "step by step" at line 9 to
"step-by-step" (compound adjective), "human readable" at line 39 to
"human-readable" (compound adjective), "set up" at line 64 used as a noun to
"set-up", and "decision making" at line 201 to "decision-making"; update the
text accordingly while preserving surrounding punctuation and spacing.
| If you observe a significant impact on the primary metric but no significant differences on the secondary metrics then the impact observed on the | ||
| The primary metric is likely a false positive. For more information, check our article on interpreting results and making decisions. |
There was a problem hiding this comment.
Fix malformed sentence: incomplete phrase and duplicate text (lines 167–168).
The sentence structure is broken. Currently reads: "...then the impact observed on the [line break] The primary metric is likely a false positive."
This contains a dangling phrase ("on the") and redundant text ("The primary" repeated). The intended meaning should be:
- If you observe a significant impact on the primary metric but no significant differences on the secondary metrics then the impact observed on the
- The primary metric is likely a false positive. For more information, check our article on interpreting results and making decisions.
+ If you observe a significant impact on the primary metric but no significant differences on the secondary metrics, then the impact observed on the primary metric is likely a false positive. For more information, check our article on interpreting results and making decisions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~167-~167: Possible missing comma found.
Context: ...ignificant differences on the secondary metrics then the impact observed on the The pr...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~167-~167: Possible typo: you repeated a word.
Context: ...ary metrics then the impact observed on the The primary metric is likely a false positi...
(ENGLISH_WORD_REPEAT_RULE)
🤖 Prompt for AI Agents
In docs/web-console-docs/creating-an-experiment.mdx around lines 167 to 168, the
sentence is malformed with a dangling "on the" and duplicated "The primary"
text; replace the two lines with a single corrected sentence such as: "If you
observe a significant impact on the primary metric but no significant
differences on the secondary metrics, then the impact observed on the primary
metric is likely a false positive." and keep the following sentence linking to
the article on interpreting results and making decisions.
|
|
||
| ## Team structure | ||
|
|
||
| The first building block was to make it possible to map your internal team structure in ABsmartly so your teams can be structured just like they are in your organisation. |
There was a problem hiding this comment.
Add comma before "so" in compound sentence.
Line 14 contains a compound sentence that needs a comma before "so" for proper punctuation.
-The first building block was to make it possible to map your internal team structure in ABsmartly so your teams can be structured just like they are in your organisation.
+The first building block was to make it possible to map your internal team structure in ABsmartly, so your teams can be structured just like they are in your organisation.📝 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.
| The first building block was to make it possible to map your internal team structure in ABsmartly so your teams can be structured just like they are in your organisation. | |
| The first building block was to make it possible to map your internal team structure in ABsmartly, so your teams can be structured just like they are in your organisation. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...our internal team structure in ABsmartly so your teams can be structured just like ...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~14-~14: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...e structured just like they are in your organisation. <Image img="ownership-model/team-stru...
(OXFORD_SPELLING_Z_NOT_S)
🤖 Prompt for AI Agents
In docs/web-console-docs/ownership-and-permissions.mdx around line 14, the
sentence "The first building block was to make it possible to map your internal
team structure in ABsmartly so your teams can be structured just like they are
in your organisation." lacks a comma before the coordinating conjunction "so";
insert a comma immediately before "so" to form "...ABsmartly, so your teams..."
to correct the compound sentence punctuation.
|
|
||
| A Group Sequential test can be configured on the Analysis step (Step 5) of the experimentation setup. | ||
| To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article](/docs/web-console-docs/type-of-analysis). | ||
| To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article](/docs/web-console-docs/types-of-analysis). |
There was a problem hiding this comment.
Add missing comma before "check".
Line 15 is missing a comma before "check our" in this compound sentence. Update to: "...experiment, check our [analysis type article]..."
-To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article](/docs/web-console-docs/types-of-analysis).
+To understand the differences between Group Sequential and Fixed Horizon experiment, check our [analysis type article](/docs/web-console-docs/types-of-analysis).📝 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.
| To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article](/docs/web-console-docs/types-of-analysis). | |
| To understand the differences between Group Sequential and Fixed Horizon experiment, check our [analysis type article](/docs/web-console-docs/types-of-analysis). |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...ween Group Sequential and Fixed Horizon experiment check our [analysis type article](/docs...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/setting-up-a-gst-experiment.mdx around line 15, the
sentence "To understand the differences between Group Sequential and Fixed
Horizon experiment check our [analysis type
article](/docs/web-console-docs/types-of-analysis)." is missing a comma before
"check"; insert a comma after "experiment" so it reads "...experiment, check our
[analysis type article](/docs/web-console-docs/types-of-analysis)." to correct
the punctuation.
| ::: | ||
|
|
||
| If the metric you are selecting is not new and we have already collected data for it, you will see the metric's performance graph below. | ||
| If the metric you are selecting is not new and we have already collected data for it, you will see a button to show the metrics performance graph. |
There was a problem hiding this comment.
Add comma before "and" in compound sentence.
Line 84 contains two independent conditions joined by "and" that require a comma for proper punctuation. Update: "...is not new and we have already collected data for it, you will see..."
-If the metric you are selecting is not new and we have already collected data for it, you will see a button to show the metrics performance graph.
+If the metric you are selecting is not new, and we have already collected data for it, you will see a button to show the metrics performance graph.📝 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.
| If the metric you are selecting is not new and we have already collected data for it, you will see a button to show the metrics performance graph. | |
| If the metric you are selecting is not new, and we have already collected data for it, you will see a button to show the metrics performance graph. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~84-~84: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the metric you are selecting is not new and we have already collected data for it, ...
(COMMA_COMPOUND_SENTENCE)
🤖 Prompt for AI Agents
In docs/web-console-docs/setting-up-a-gst-experiment.mdx around line 84, add a
comma before the conjunction "and" in the conditional clause: change "If the
metric you are selecting is not new and we have already collected data for it,
you will see a button..." to "If the metric you are selecting is not new, and we
have already collected data for it, you will see a button..." ensuring the comma
is placed immediately after "new".
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/web-console-docs/Events/visitors-identity.mdx (2)
12-12: Fix grammar and spelling errors from past review.Line 12 still contains two unresolved issues from the previous review: "Identify" should be "Identity", and "enrish" should be "enrich".
Apply this diff:
-The Visitors Identify is used by the SDKs to create and enrish the experimentation context from which exposure and goals events can be triggered. +The Visitors Identity is used by the SDKs to create and enrich the experimentation context from which exposure and goals events can be triggered.
41-41: Fix grammatical agreement: use plural "variants".Line 41 uses singular "variant" but the context discusses multiple
anonymous_idvalues, which should result in plural "variants".Apply this diff:
-Others like `anonymous_id` are much more transient. This means that the same physical person could potentially have several `anonymous_id` (and as a result see a different variant of your experiment). +Others like `anonymous_id` are much more transient. This means that the same physical person could potentially have several `anonymous_id` (and as a result see different variants of your experiment).docs/web-console-docs/Events/downloading-events.mdx (1)
25-27: Fix typo: "us" should be "is".Line 26 contains an unresolved typo from the previous review: "us" should be "is".
Apply this diff:
:::Note -The link to download the file us only valid for 30 days. A new request can be made if the link has expired. +The link to download the file is only valid for 30 days. A new request can be made if the link has expired. :::
🧹 Nitpick comments (2)
docs/web-console-docs/Events/exposure-events.mdx (1)
36-36: Consider using American English spelling for consistency.Line 36 uses British English spelling "initialise". If the project guidelines favour American English, this should be updated to "initialize" for consistency across the documentation.
docs/web-console-docs/Events/the-events-page.mdx (1)
34-35: Add comma before "and" in compound sentence.Line 34 forms a compound sentence with two independent clauses. A comma should be added before "and" for clarity.
Apply this diff:
-[Goal events](goal-events) are sent by the SDKs when the `track` function is called and they +[Goal events](goal-events) are sent by the SDKs when the `track` function is called, and they
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/events_list.pngis excluded by!**/*.png
📒 Files selected for processing (6)
docs/web-console-docs/Events/downloading-events.mdx(1 hunks)docs/web-console-docs/Events/exposure-events.mdx(1 hunks)docs/web-console-docs/Events/goal-events.mdx(1 hunks)docs/web-console-docs/Events/the-events-page.mdx(1 hunks)docs/web-console-docs/Events/visitors-identity.mdx(1 hunks)docs/web-console-docs/events.mdx(0 hunks)
💤 Files with no reviewable changes (1)
- docs/web-console-docs/events.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/Events/downloading-events.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...ynchronously. - When the export file is ready a notification will show on the report'...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: Possible missing comma found.
Context: ... is similar to GZIP in compression level but faster, and less widely supported. LZ4 ...
(AI_HYDRA_LEO_CPT_BUT_CBUT)
docs/web-console-docs/Events/exposure-events.mdx
[style] ~33-~33: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... making the assignment sticky. This is a very important feature as this means the same visitor ...
(EN_WEAK_ADJECTIVE)
[style] ~36-~36: Would you like to use the Oxford spelling “initialize”? The spelling ‘initialise’ is also correct.
Context: ...exposure events, make sure to correctly initialise and enrich the ABsmartly's context with...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...e your tracking is set up properly. :::tip You can even start monitoring the even...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Events/goal-events.mdx
[style] ~28-~28: Would you like to use the Oxford spelling “initialize”? The spelling ‘initialise’ is also correct.
Context: ...ing goal events, make sure to correctly initialise the ABsmartly's context and enrich it w...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/Events/the-events-page.mdx
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...SDKs when the track function is called and they include any properties that were p...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~52-~52: A comma is probably missing here.
Context: ...on those events ## Events Filters For debugging it can be useful to filter the incoming...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[style] ~64-~64: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Unit Type Select which unit types you want to see events from. Common unit types are ...
(REP_WANT_TO_VB)
docs/web-console-docs/Events/visitors-identity.mdx
[uncategorized] ~9-~9: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... Visitors Identity ## What is it? The Visitors Identity is used to uniquely identify a...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~12-~12: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ue identifiers and the attributes. The Visitors Identify is used by the SDKs to create ...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~16-~16: Would you like to use the Oxford spelling “initialized”? The spelling ‘initialised’ is also correct.
Context: ...iers The ABsmartly context needs to be initialised with your visitors' identifier(s). Tho...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~23-~23: Would you like to use the Oxford spelling “initialized”? The spelling ‘initialised’ is also correct.
Context: ...ple on how the ABsmartly context can be initialised with 3 different Visitors Identifiers. ...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...y have several anonymous_id (and as a result see a different variant of your experim...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
| } | ||
| ``` | ||
|
|
||
| Below is an overview of some of the data you will find in the exposure event's raw data. |
There was a problem hiding this comment.
Fix copy-paste error: incorrect event type reference.
Line 74 references "exposure event's" but should reference "goal event's" since this section documents goal events payload structure.
Apply this diff:
-Below is an overview of some of the data you will find in the exposure event's raw data.
+Below is an overview of some of the data you will find in the goal event's raw data.📝 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.
| Below is an overview of some of the data you will find in the exposure event's raw data. | |
| Below is an overview of some of the data you will find in the goal event's raw data. |
🤖 Prompt for AI Agents
In docs/web-console-docs/Events/goal-events.mdx around line 74, the sentence
currently references "exposure event's" but should refer to "goal event's" —
update the text to replace "exposure event's" with "goal event's" so the
description correctly matches the goal events payload section.
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (2)
docs/web-console-docs/Events/visitors-identity.mdx (2)
12-12: Unresolved past review issue: "Identify" should be "Identity".This issue was flagged in a previous review but remains unfixed. Line 12 should read "The Visitors Identity is used by the SDKs..." not "Identify".
Apply this diff:
-The Visitors Identify is used by the SDKs to create and enrich the experimentation context from which exposure and goals events can be triggered. +The Visitors Identity is used by the SDKs to create and enrich the experimentation context from which exposure and goals events can be triggered.
41-41: Unresolved past review issue: "variant" should be "variants".This issue was flagged in a previous review but remains unfixed. Line 41 should use the plural "variants" for grammatical agreement: "see different variants of your experiment".
Apply this diff:
-Others like `anonymous_id` are much more transient. This means that the same physical person could potentially have several `anonymous_id` (and as a result see a different variant of your experiment). +Others like `anonymous_id` are much more transient. This means that the same physical person could potentially have several `anonymous_id` (and as a result see different variants of your experiment).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
static/img/configuration/applications.pngis excluded by!**/*.pngstatic/img/configuration/units.pngis excluded by!**/*.png
📒 Files selected for processing (7)
docs/web-console-docs/Configuration/Applications.mdx(1 hunks)docs/web-console-docs/Configuration/Units.mdx(1 hunks)docs/web-console-docs/Configuration/_category_.json(1 hunks)docs/web-console-docs/Configuration/settings.mdx(1 hunks)docs/web-console-docs/Events/downloading-events.mdx(1 hunks)docs/web-console-docs/Events/the-events-page.mdx(1 hunks)docs/web-console-docs/Events/visitors-identity.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/web-console-docs/Configuration/category.json
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/Configuration/Units.mdx
[uncategorized] ~10-~10: Possible missing preposition found.
Context: ...applications). Units are also referred as tracking identifiers. For experiments ...
(AI_HYDRA_LEO_MISSING_TO)
[grammar] ~19-~19: The usual collocation for technology is “on”, not “in”.
Context: ...nterested in collecting metrics tracked in the website that the newsletter is linking to, it'...
(IN_THE_INTERNET)
[grammar] ~20-~20: The usual collocation for technology is “on”, not “in”.
Context: ... being used for the experiments running in the website. Have a look at the [Tracking Unit](/d...
(IN_THE_INTERNET)
[uncategorized] ~33-~33: Possible missing preposition found.
Context: ...0rem" centered /> :::info to be able experiment on this application you will first need...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ... :::info to be able experiment on this application you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Events/visitors-identity.mdx
[uncategorized] ~9-~9: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... Visitors Identity ## What is it? The Visitors Identity is used to uniquely identify a...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~12-~12: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ue identifiers and the attributes. The Visitors Identify is used by the SDKs to create ...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~16-~16: Would you like to use the Oxford spelling “initialized”? The spelling ‘initialised’ is also correct.
Context: ...iers The ABsmartly context needs to be initialised with your visitors' identifier(s). Tho...
(OXFORD_SPELLING_Z_NOT_S)
[misspelling] ~21-~21: Did you mean “known”?
Context: ...ment. Those tracking identifiers (also know as Units) need to be pre-registered on ...
(KNOW_KNOWN)
[style] ~23-~23: Would you like to use the Oxford spelling “initialized”? The spelling ‘initialised’ is also correct.
Context: ...ple on how the ABsmartly context can be initialised with 3 different unit types. ```javasc...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...y have several anonymous_id (and as a result see a different variant of your experim...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Configuration/Applications.mdx
[uncategorized] ~22-~22: Possible missing preposition found.
Context: ...0rem" centered /> :::info to be able experiment on this application you will first need...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ... :::info to be able experiment on this application you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Events/the-events-page.mdx
[uncategorized] ~52-~52: A comma is probably missing here.
Context: ...on those events ## Events Filters For debugging it can be useful to filter the incoming...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[style] ~64-~64: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Unit Type Select which unit types you want to see events from. Common unit types are ...
(REP_WANT_TO_VB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (2)
docs/web-console-docs/Events/downloading-events.mdx (1)
1-84: Typos from past review have been successfully fixed.The previous issues identified in the past review (typo corrections: "us" → "is" and "as expired" → "has expired" on lines 25–27) have been properly addressed. The import path at line 5 correctly resolves to the shared Image component. The documentation structure and content look sound.
docs/web-console-docs/Configuration/settings.mdx (1)
5-5: Correct import path depth for shared Image component.The import path has been correctly adjusted to reach the shared Image component. The old path ("../../src/components/Image") was incorrect; the new path ("../../../src/components/Image") properly resolves to
docs/src/components/Image, consistent with other newly added Configuration pages.
| /> | ||
|
|
||
| :::info | ||
| to be able experiment on this application you will first need to install the ABsmartly's SDK. |
There was a problem hiding this comment.
Fix grammar: missing preposition and incorrect possessive form.
Line 22 has grammatical issues. It should read "to be able to experiment on this application" (missing "to"), and "ABsmartly" should not have a possessive apostrophe since it's a product name.
Apply this diff:
-to be able experiment on this application you will first need to install the ABsmartly's SDK.
+To be able to experiment on this application, you will first need to install the ABsmartly SDK.📝 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.
| to be able experiment on this application you will first need to install the ABsmartly's SDK. | |
| To be able to experiment on this application, you will first need to install the ABsmartly SDK. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing preposition found.
Context: ...0rem" centered /> :::info to be able experiment on this application you will first need...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ... :::info to be able experiment on this application you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/Configuration/Applications.mdx around line 22, the
sentence has grammar errors: add the missing preposition "to" after "be able"
and remove the incorrect possessive apostrophe from "ABsmartly's"; change the
fragment to read "to be able to experiment on this application you will first
need to install the ABsmartly SDK" (or capitalize "To" and add punctuation as
needed) so the product name is not possessive and the infinitive is correct.
| /> | ||
|
|
||
| :::info | ||
| to be able experiment on this application you will first need to install the ABsmartly's SDK. |
There was a problem hiding this comment.
Fix grammar: missing preposition and incorrect possessive form.
Line 33 has the same grammatical issues as the Applications page. It should read "to be able to experiment on this application" (missing "to"), and "ABsmartly" should not have a possessive apostrophe.
Apply this diff:
-to be able experiment on this application you will first need to install the ABsmartly's SDK.
+To be able to experiment on this application, you will first need to install the ABsmartly SDK.📝 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.
| to be able experiment on this application you will first need to install the ABsmartly's SDK. | |
| To be able to experiment on this application, you will first need to install the ABsmartly SDK. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: Possible missing preposition found.
Context: ...0rem" centered /> :::info to be able experiment on this application you will first need...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ... :::info to be able experiment on this application you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/Configuration/Units.mdx around line 33, fix the grammar
by inserting the missing preposition "to" and removing the incorrect possessive
apostrophe from "ABsmartly's"; update the sentence to read "to be able to
experiment on this application you will first need to install the ABsmartly
SDK." Ensure spacing and capitalization remain consistent.
| For debugging it can be useful to filter the incoming events to narrow them | ||
| down to the specific events that you are looking for. |
There was a problem hiding this comment.
Add comma after introductory phrase.
Line 52 should include a comma after the introductory phrase "For debugging". It should read "For debugging, it can be useful to filter the incoming events..."
Apply this diff:
-For debugging it can be useful to filter the incoming events to narrow them
+For debugging, it can be useful to filter the incoming events to narrow them📝 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.
| For debugging it can be useful to filter the incoming events to narrow them | |
| down to the specific events that you are looking for. | |
| For debugging, it can be useful to filter the incoming events to narrow them | |
| down to the specific events that you are looking for. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: A comma is probably missing here.
Context: ...on those events ## Events Filters For debugging it can be useful to filter the incoming...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
🤖 Prompt for AI Agents
In docs/web-console-docs/Events/the-events-page.mdx around lines 52 to 53, add a
missing comma after the introductory phrase: change "For debugging it can be
useful to filter the incoming events to narrow them down to the specific events
that you are looking for." to insert a comma after "For debugging" so the
sentence reads "For debugging, it can be useful to filter the incoming events to
narrow them down to the specific events that you are looking for."
| to link them to the goals events they are triggering as they use your products. | ||
| What identifiers exist depends on where the experiment is running and what you know about the visitor at that moment. | ||
|
|
||
| Those tracking identifiers (also know as Units) need to be pre-registered on the ABsmartly platform, see [Units](../configuration/units) for more details. |
There was a problem hiding this comment.
Fix grammar: "know" should be "known".
Line 21 uses incorrect grammar. The phrase should read "Those tracking identifiers (also known as Units)" not "know".
Apply this diff:
-Those tracking identifiers (also know as Units) need to be pre-registered on the ABsmartly platform, see [Units](../configuration/units) for more details.
+Those tracking identifiers (also known as Units) need to be pre-registered on the ABsmartly platform, see [Units](../configuration/units) for more details.📝 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.
| Those tracking identifiers (also know as Units) need to be pre-registered on the ABsmartly platform, see [Units](../configuration/units) for more details. | |
| Those tracking identifiers (also known as Units) need to be pre-registered on the ABsmartly platform, see [Units](../configuration/units) for more details. |
🧰 Tools
🪛 LanguageTool
[misspelling] ~21-~21: Did you mean “known”?
Context: ...ment. Those tracking identifiers (also know as Units) need to be pre-registered on ...
(KNOW_KNOWN)
🤖 Prompt for AI Agents
In docs/web-console-docs/Events/visitors-identity.mdx around line 21, fix the
grammar in the parenthetical by replacing "also know as Units" with "also known
as Units" so the sentence reads: "Those tracking identifiers (also known as
Units) need to be pre-registered on the ABsmartly platform, see
[Units](../configuration/units) for more details."
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/web-console-docs/creating-an-experiment.mdx (1)
9-9: Note: Unresolved grammar issues from previous reviews remain in the file.Several hyphenation and sentence structure issues that were flagged in earlier reviews are still present:
- Line 9: "step by step" → "step-by-step"
- Line 39: "human readable" → "human-readable"
- Line 64: "set up" (noun) → "set-up"
- Line 167–168: Malformed sentence with incomplete phrase and text duplication
- Line 201: "decision making" → "decision-making"
These are outside the scope of the current PR (which focuses on link updates), but tracking these for future refinement.
Also applies to: 39-39, 64-64, 167-168, 201-201
docs/web-console-docs/Events/the-events-page.mdx (1)
52-53: Add missing comma after introductory phrase.Line 52 needs a comma after "For debugging" to improve readability and follow correct punctuation rules.
-For debugging it can be useful to filter the incoming events to narrow them +For debugging, it can be useful to filter the incoming events to narrow them
🧹 Nitpick comments (1)
docs/web-console-docs/Events/the-events-page.mdx (1)
64-64: Vary phrasing to reduce repetition.The phrase "unit types" appears twice in consecutive sentences, which affects writing variety. Consider rephrasing the second instance to maintain reader engagement.
-Select which unit types you want to see events from. Common unit types are `user_id` +Select which unit types you want to see events from. Common examples are `user_id`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
docs/Examples/Slack-Integration/index.mdx(2 hunks)docs/SDK-Documentation/Advanced/context-attributes/setting-context-attributes/_setting-context-attributes.mdx(1 hunks)docs/SDK-Documentation/Advanced/using-custom-fields-in-your-code.mdx(3 hunks)docs/SDK-Documentation/getting-started/import-and-initialize/_import-and-initialize.mdx(1 hunks)docs/web-console-docs/Configuration/_category_.json(1 hunks)docs/web-console-docs/Events/the-events-page.mdx(1 hunks)docs/web-console-docs/Users, Teams & Permissions/_category_.json(1 hunks)docs/web-console-docs/creating-a-feature.mdx(1 hunks)docs/web-console-docs/creating-an-experiment.mdx(3 hunks)docs/web-console-docs/tutorial.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- docs/SDK-Documentation/Advanced/context-attributes/setting-context-attributes/_setting-context-attributes.mdx
- docs/SDK-Documentation/getting-started/import-and-initialize/_import-and-initialize.mdx
- docs/web-console-docs/Users, Teams & Permissions/category.json
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/creating-an-experiment.mdx
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...s experiment, assign it to a particular team and add tags to help with searching and...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...riment, what you hope for the result to be and what will be done after any of the ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Events/the-events-page.mdx
[uncategorized] ~52-~52: A comma is probably missing here.
Context: ...on those events ## Events Filters For debugging it can be useful to filter the incoming...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[style] ~64-~64: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Unit Type Select which unit types you want to see events from. Common unit types are ...
(REP_WANT_TO_VB)
docs/web-console-docs/creating-a-feature.mdx
[style] ~54-~54: Would you like to use the Oxford spelling “customized”? The spelling ‘customised’ is also correct.
Context: ...to your feature flag. This step can be customised in [the Platform Settings](/docs/web-co...
(OXFORD_SPELLING_Z_NOT_S)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (10)
docs/web-console-docs/tutorial.mdx (1)
66-66: Link path updated correctly to reflect new Configuration directory structure.The link update from
/docs/web-console-docs/settings#tagsto/docs/web-console-docs/configuration/settings#tagsaligns with the PR's reorganisation of documentation into a Configuration subdirectory. The anchor reference (#tags) is preserved correctly.Please verify that the target path
/docs/web-console-docs/configuration/settings#tagsresolves correctly once this PR is merged, confirming that the settings documentation has been migrated to the Configuration directory as indicated in the PR summary.docs/web-console-docs/creating-an-experiment.mdx (2)
96-96: Link paths updated correctly to reflect new configuration structure.The updates to the settings link anchors now point to
/docs/web-console-docs/configuration/settingsrather than the legacy/docs/web-console-docs/settingspath. This aligns with the documentation reorganisation in this PR.Please verify that the new configuration/settings anchors (
#unitsand#applications) are defined in the target documentation file to ensure links resolve correctly.Also applies to: 101-101
238-238: Links updated correctly; static analysis hints are false positives.The configuration/settings path updates are consistent with the documentation reorganisation. The static analysis hints about missing commas are not applicable—both sentences are grammatically correct without additional commas per modern English style.
Verify that the
#platform-settingsanchor exists in the target configuration/settings documentation file.Also applies to: 253-253
docs/web-console-docs/creating-a-feature.mdx (1)
54-54: Link path update is appropriate; static analysis flag is a false positive.The updated path
/docs/web-console-docs/configuration/settings#platform-settingsis consistent with the PR's restructuring of settings into a Configuration subdirectory. The spelling "customised" is correct British English and is appropriate for the en-GB review context, so the LanguageTool flag can be safely dismissed.docs/SDK-Documentation/Advanced/using-custom-fields-in-your-code.mdx (1)
3-3: All three link path updates are consistent and appropriate.The updates across lines 3, 21, and 34 all follow the same migration pattern:
/docs/web-console-docs/settings#…→/docs/web-console-docs/configuration/settings#…. These changes align with the PR's restructuring of settings into a Configuration subdirectory.Also applies to: 21-21, 34-34
docs/web-console-docs/Configuration/_category_.json (1)
1-6: Category configuration file is well-structured and properly positioned.The JSON structure is valid and the configuration settings are appropriate. Position 52 places this category logically after Events (50) and Users, Teams & Permissions (51). The collapsible flag is sensible given that this category will contain multiple documentation pages.
docs/Examples/Slack-Integration/index.mdx (1)
194-204: All link destinations verified—no issues found.The verification confirms all 12 updated links in the Slack integration file reference valid anchors in the Configuration/settings.mdx file. Every experiment event type link (lines 194–204) and the Webhook Payloads reference (line 249) point to existing destinations with correct anchor fragments.
docs/web-console-docs/Events/the-events-page.mdx (3)
60-60: Anchor links verified — no issues found.The referenced anchors exist in the target configuration/settings.mdx file:
#unitsanchor is present (heading: "## Units")#environmentsanchor is present (heading: "## Environments")All links on lines 60, 66, and 84 are valid.
5-5: Import path verified—no issues found.The relative path
../../../src/components/Image/correctly resolves fromdocs/web-console-docs/Events/to the Image component directory. The component files (Image.tsx and index.ts) are present and accessible. The import is valid.
28-28: Links are correctly formatted for Docusaurus routing; no changes required.The links at lines 28, 34, 48, and 97 use the correct relative format for Docusaurus file-based routing. Docusaurus automatically resolves extension-less links like
(exposure-events)toexposure-events.mdx. All referenced documentation files exist and the format is consistent with other links throughout the Events documentation directory.Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
docs/web-console-docs/Configuration/Units.mdx (2)
10-10: Fix grammar: missing preposition "to".Line 10 should read "Units are also referred to as tracking identifiers" not "referred as".
Apply this diff:
-Units are also referred as tracking identifiers. +Units are also referred to as tracking identifiers.
19-20: Fix collocation: "in the website" should be "on the website".Lines 19–20 use the incorrect collocation "in the website"; the correct form for technology contexts is "on the website".
Apply this diff:
-but if you are interested in collecting metrics tracked in the website that the newsletter is linking to, -it's better to use the same unit that is being used for the experiments running in the website. +but if you are interested in collecting metrics tracked on the website that the newsletter is linking to, +it's better to use the same unit that is being used for the experiments running on the website.docs/web-console-docs/Configuration/Applications.mdx (1)
24-24: Fix grammar: missing preposition, incorrect possessive, and missing comma.Line 24 has three grammatical issues: it should read "To be able to experiment on this application, you will first need to install the ABsmartly SDK" (not "ABsmartly's"). The missing "to" after "be able", the incorrect possessive apostrophe, and a missing comma are all required.
Apply this diff:
-To be able experiment on this application you will first need to install the ABsmartly's SDK. +To be able to experiment on this application, you will first need to install the ABsmartly SDK.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/web-console-docs/Configuration/Applications.mdx(1 hunks)docs/web-console-docs/Configuration/Units.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/Configuration/Applications.mdx
[uncategorized] ~24-~24: Possible missing preposition found.
Context: ...em" centered /> :::info To be able experiment on this application you will first need...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ... :::info To be able experiment on this application you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Configuration/Units.mdx
[uncategorized] ~10-~10: Possible missing preposition found.
Context: ...applications). Units are also referred as tracking identifiers. For experiments ...
(AI_HYDRA_LEO_MISSING_TO)
[grammar] ~19-~19: The usual collocation for technology is “on”, not “in”.
Context: ...nterested in collecting metrics tracked in the website that the newsletter is linking to, it'...
(IN_THE_INTERNET)
[grammar] ~20-~20: The usual collocation for technology is “on”, not “in”.
Context: ... being used for the experiments running in the website. Have a look at the [Tracking Unit](/d...
(IN_THE_INTERNET)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...y have several anonymous_id (and as a result see a different variant of your experim...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/platform-release-notes/2025/06.mdx(1 hunks)docs/platform-release-notes/2025/11.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/platform-release-notes/2025/11.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
| - Structuring teams hierarchically (e.g. parent and child teams) | ||
|
|
||
| This is the first step toward upcoming improvements around ownership, permissions, and team-level collaboration. Go to `Settings > Teams` to get started with managing your team and inviting your team members. If you already have teams defined in ABsmartly, you can simply move them to the right place in your org structure. Check our [wiki page](/docs/web-console-docs/creating-and-managing-teams) for more information on creating and managing teams in ABsmartly. | ||
| This is the first step toward upcoming improvements around ownership, permissions, and team-level collaboration. Go to `Settings > Teams` to get started with managing your team and inviting your team members. If you already have teams defined in ABsmartly, you can simply move them to the right place in your org structure. Check our [wiki page](/docs/web-console-docs/users-teams-permissions/creating-and-managing-teams) for more information on creating and managing teams in ABsmartly. |
There was a problem hiding this comment.
🧩 Analysis chain
Verify the documentation link points to an existing or newly created page.
The link has been updated to /docs/web-console-docs/users-teams-permissions/creating-and-managing-teams as part of the documentation restructuring. Please confirm that this new documentation path exists or is being created as part of this PR.
🏁 Script executed:
#!/bin/bash
# Description: Verify the new documentation path exists in the repository.
# Expected: The file should exist at the new path or be created as part of this PR.
# Search for the creating-and-managing-teams file
fd -t f 'creating-and-managing-teams' docs/
# Also check if the users-teams-permissions directory exists
fd -t d 'users-teams-permissions' docs/Length of output: 124
Correct the documentation link path casing—it will result in a 404 error.
The file exists, but there's a case mismatch. The link references users-teams-permissions (all lowercase), but the actual directory is Users-teams-Permissions (mixed case). Update the link to:
/docs/web-console-docs/Users-teams-Permissions/creating-and-managing-teams
Without this correction, the link will fail in production.
🤖 Prompt for AI Agents
In docs/platform-release-notes/2025/06.mdx around line 16, the link to the team
management doc uses the wrong directory casing and will 404 in production;
update the markdown link path from
/docs/web-console-docs/users-teams-permissions/creating-and-managing-teams to
use the correct casing
/docs/web-console-docs/Users-teams-Permissions/creating-and-managing-teams so it
matches the actual directory name.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/web-console-docs/Configuration/Applications.mdx(1 hunks)docs/web-console-docs/experiments/_category_.json(1 hunks)docs/web-console-docs/feature-flags/_category_.json(1 hunks)docs/web-console-docs/feature-flags/creating-a-feature.mdx(3 hunks)docs/web-console-docs/goals-and-metrics/_category_.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/feature-flags/creating-a-feature.mdx
[style] ~52-~52: Would you like to use the Oxford spelling “customized”? The spelling ‘customised’ is also correct.
Context: ...to your feature flag. This step can be customised in [the Platform Settings](/docs/web-co...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/Configuration/Applications.mdx
[grammar] ~24-~24: The singular determiner ‘this’ may not agree with the plural noun ‘applications’. Did you mean “these”?
Context: ... :::info To be able to experiment on this applications you will first need to ins...
(THIS_NNS)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...::info To be able to experiment on this applications you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (7)
docs/web-console-docs/experiments/_category_.json (1)
1-6: Configuration file looks good.The JSON structure is valid and correctly configured for the Experiments category.
docs/web-console-docs/feature-flags/_category_.json (1)
1-6: Configuration file looks good.The JSON structure is valid and correctly configured for the Feature Flags category.
docs/web-console-docs/goals-and-metrics/_category_.json (1)
1-6: Configuration file looks good.The JSON structure is valid and correctly configured for the Goals & Metrics category.
docs/web-console-docs/feature-flags/creating-a-feature.mdx (4)
5-6: ✓ Import paths correctly adjusted.The relative paths to Image and FutureDate components appear correctly positioned for the file location and align with the documentation restructuring.
35-37: Verify new configuration documentation pages exist.The Audiences section now references
/docs/web-console-docs/configuration/unitsand/docs/web-console-docs/configuration/applications. Please confirm these new configuration pages have been created as part of this restructuring PR.
43-45: ✓ Metrics section wording improved for clarity.The updated phrasing—beginning with "In this step, you can choose..." and explicitly clarifying that primary metrics are not required for feature flags—enhances user understanding and appropriately differentiates feature flags from experiments.
52-52: ✓ Platform Settings link correctly updated to new configuration path.The updated link to
/docs/web-console-docs/configuration/settings#platform-settingsappropriately reflects the new documentation structure and is consistent with other configuration references in this file.
|
|
||
|
|
||
| :::info | ||
| To be able to experiment on this applications you will first need to install the ABsmartly's SDK. |
There was a problem hiding this comment.
Fix grammar: subject-verb agreement and product name possessive form.
Line 24 has two grammatical issues. The singular determiner 'this' does not agree with the plural noun 'applications', and the product name 'ABsmartly' should not be possessive.
Apply this diff:
-To be able to experiment on this applications you will first need to install the ABsmartly's SDK.
+To be able to experiment on these applications you will first need to install the ABsmartly SDK.Alternatively, if the context should refer to a single application, use 'this application' instead.
📝 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.
| To be able to experiment on this applications you will first need to install the ABsmartly's SDK. | |
| To be able to experiment on these applications you will first need to install the ABsmartly SDK. |
🧰 Tools
🪛 LanguageTool
[grammar] ~24-~24: The singular determiner ‘this’ may not agree with the plural noun ‘applications’. Did you mean “these”?
Context: ... :::info To be able to experiment on this applications you will first need to ins...
(THIS_NNS)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...::info To be able to experiment on this applications you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
There was a problem hiding this comment.
Actionable comments posted: 8
♻️ Duplicate comments (1)
docs/web-console-docs/Configuration/Applications.mdx (1)
21-21: Fix missing comma and incorrect possessive form of product name.When describing function or performance, avoid forming a possessive from a product name; instead, use the name as a modifier. Additionally, a comma is needed after the introductory clause.
Apply this diff:
-To be able to experiment on these applications you will first need to install the ABsmartly's SDK. +To be able to experiment on these applications, you will first need to install the ABsmartly SDK.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/configuration/goals.pngis excluded by!**/*.png
📒 Files selected for processing (20)
docs/web-console-docs/Configuration/Applications.mdx(1 hunks)docs/web-console-docs/Configuration/settings.mdx(1 hunks)docs/web-console-docs/Users-teams-Permissions/_category_.json(1 hunks)docs/web-console-docs/creating-an-experiment.mdx(4 hunks)docs/web-console-docs/goals-and-metrics/goals/_category_.json(1 hunks)docs/web-console-docs/goals-and-metrics/goals/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/goals/overview.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/Understanding-experimentation-metrics.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/_category_.json(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/categories.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/_category_.json(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/property.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/ratio.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/unique-property-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/overview.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (8)
- docs/web-console-docs/goals-and-metrics/metrics/Understanding-experimentation-metrics.mdx
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/property.mdx
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/ratio.mdx
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/category.json
- docs/web-console-docs/goals-and-metrics/metrics/category.json
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/web-console-docs/Users-teams-Permissions/category.json
- docs/web-console-docs/Configuration/settings.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/creating-an-experiment.mdx
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...s experiment, assign it to a particular team and add tags to help with searching and...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...riment, what you hope for the result to be and what will be done after any of the ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx
[grammar] ~12-~12: Did you mean “are” or “were”?
Context: ...hat to observe in the experiment. Goals is the raw data used to compute [Metrics](...
(SENT_START_NNS_IS)
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...se** was triggered. To learn more about events you can read the dedicated page [Goal E...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Configuration/Applications.mdx
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...:info To be able to experiment on these applications you will first need to install the ABsm...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/goals/create.mdx
[grammar] ~23-~23: Possible agreement error - use third-person verb forms for singular and mass nouns.
Context: ...Description**| Describes what this goal track. | | Owners| The list of goal owner...
(MASS_AGREEMENT)
[uncategorized] ~32-~32: Possible missing comma found.
Context: ... your goals to be auto-created. When in doubt reach out to ABsmartly Support. :::
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/categories.mdx
[uncategorized] ~9-~9: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...y is a label that groups related metrics so teams can find, compare, and report on ...
(COMMA_COMPOUND_SENTENCE_2)
[misspelling] ~16-~16: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...d. ## Create & Manage You can create an manage Metrics Categories by going to `...
(EN_A_VS_AN)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~9-~9: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...y is a label that groups related metrics so teams can find, compare, and report on ...
(COMMA_COMPOUND_SENTENCE_2)
[misspelling] ~16-~16: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...d. ## Create & Manage You can create an manage Metrics Categories by going to `...
(EN_A_VS_AN)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx
[grammar] ~5-~5: Utilisez les accents correctement
Context: --- sidebar_position: 6 --- # Retention
(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_DIACRITIC_ACUTE)
🔇 Additional comments (10)
docs/web-console-docs/goals-and-metrics/goals/_category_.json (1)
1-6: LGTM!Category metadata is correctly formatted and structured.
docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx (1)
1-5: LGTM!File structure is correct. Note: the static analysis hint about French accents is a false positive and can be ignored.
docs/web-console-docs/goals-and-metrics/metrics/metric-types/unique-property-count.mdx (1)
1-5: LGTM!File structure and heading are correct.
docs/web-console-docs/goals-and-metrics/goals/create.mdx (1)
29-29: Verify internal link path.Line 29 contains an internal link to
/docs/web-console-docs/events/goal-events. Please confirm this path is correct and that the linked page exists with this URL structure.docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (1)
1-13: LGTM!Documentation content is clear and well-written. Internal links using relative paths are correctly formatted.
docs/web-console-docs/goals-and-metrics/goals/overview.mdx (1)
29-32: Verify internal link path.Line 32 contains an internal link using relative path
../../events/goal-events. Please confirm this resolves correctly within the documentation structure and that the goal-events page exists.docs/web-console-docs/creating-an-experiment.mdx (4)
96-96: Link updates to configuration settings look correct.The path updates to point to the new
/docs/web-console-docs/configuration/settingsstructure are correctly applied for units and applications references.Also applies to: 101-101
122-122: Metrics link updated correctly to new path.The link to Understanding Experimentation Metrics is correctly updated to the new goals-and-metrics structure.
108-117: New audience targeting content is well-structured.The addition of the audience targeting image (step-3-audience.png) and the new "Audience Enforced" section with clear explanation of when audience filtering is applied and how mismatches are handled is a good enhancement to the documentation.
238-238: Link updates to platform settings are correct.Both metadata and description sections are correctly updated to reference the new configuration path for platform settings.
Also applies to: 253-253
|
|
||
| ## Overview | ||
|
|
||
| Metric category is a label that groups related metrics so teams can find, compare, and report on them consistently across experiments. |
There was a problem hiding this comment.
Fix compound sentence punctuation.
Line 9 needs a comma before "so" to properly separate the independent clauses: "...groups related metrics, so teams can find, compare, and report on them consistently..."
-Metric category is a label that groups related metrics so teams can find, compare, and report on them consistently across experiments.
+Metric category is a label that groups related metrics, so teams can find, compare, and report on them consistently across experiments. 📝 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.
| Metric category is a label that groups related metrics so teams can find, compare, and report on them consistently across experiments. | |
| Metric category is a label that groups related metrics, so teams can find, compare, and report on them consistently across experiments. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...y is a label that groups related metrics so teams can find, compare, and report on ...
(COMMA_COMPOUND_SENTENCE_2)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/create.mdx around line 9, the
sentence "Metric category is a label that groups related metrics so teams can
find, compare, and report on them consistently across experiments." is a
compound sentence that needs a comma before "so"; update the line to insert a
comma before "so" so it reads "...groups related metrics, so teams can find,
compare, and report on them consistently across experiments."
|
|
||
| ## Create & Manage | ||
|
|
||
| You can create an manage Metrics Categories by going to `Settings` and clicking on `Metric Categories`. No newline at end of file |
There was a problem hiding this comment.
Fix article and verb usage.
Line 16 contains a grammatical error. Change "create an manage" to "create and manage":
-You can create an manage Metrics Categories by going to `Settings` and clicking on `Metric Categories`.
+You can create and manage Metrics Categories by going to `Settings` and clicking on `Metric Categories`.📝 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.
| You can create an manage Metrics Categories by going to `Settings` and clicking on `Metric Categories`. | |
| You can create and manage Metrics Categories by going to `Settings` and clicking on `Metric Categories`. |
🧰 Tools
🪛 LanguageTool
[misspelling] ~16-~16: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...d. ## Create & Manage You can create an manage Metrics Categories by going to `...
(EN_A_VS_AN)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/create.mdx around line 16,
the sentence contains a grammar mistake "create an manage"; change it to "create
and manage" so the line reads: You can create and manage Metrics Categories by
going to `Settings` and clicking on `Metric Categories`.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/web-console-docs/creating-an-experiment.mdx (1)
9-9: Address previously flagged grammar and clarity issues.Multiple grammar and structural issues identified in previous reviews remain unresolved:
Hyphenation in compound adjectives/modifiers (lines 9, 39, 64, 201):
- Line 9: "step by step" → "step-by-step"
- Line 39: "human readable" → "human-readable"
- Line 64: "set up" (used as noun) → "set-up"
- Line 201: "decision making" → "decision-making"
Malformed sentence structure (lines 167–168):
The sentence contains a dangling phrase and word repetition that breaks clarity. Currently reads: "...then the impact observed on the [line break] The primary metric is likely a false positive." This should read: "...then the impact observed on the primary metric is likely a false positive."Please apply the fixes from the previous review to resolve these issues before merging.
Also applies to: 39-39, 64-64, 167-168, 201-201
🧹 Nitpick comments (1)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (1)
5-13: Internal links verified—targets exist and resolve correctly.Both link targets are valid:
../goals/overviewcorrectly points todocs/web-console-docs/goals-and-metrics/goals/overview.mdxcategoriescorrectly points todocs/web-console-docs/goals-and-metrics/metrics/categories.mdxThe optional phrasing improvement to lines 12–13 remains recommended for enhanced readability:
-Metrics can represent direct business outcomes, engagement signals, or technical performance indicators, -and are often grouped into [categories](categories) such as `conversion`, `engagement`, `retention`, or `revenue`. +Metrics can represent direct business outcomes, engagement signals, or technical performance indicators. +They are often grouped into [categories](categories) such as `conversion`, `engagement`, `retention`, or `revenue`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/web-console-docs/creating-an-experiment.mdx(4 hunks)docs/web-console-docs/goals-and-metrics/metrics/overview.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/creating-an-experiment.mdx
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...s experiment, assign it to a particular team and add tags to help with searching and...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...riment, what you hope for the result to be and what will be done after any of the ...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (2)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (1)
1-3: Front-matter structure is valid.The YAML front-matter with
sidebar_position: 1is correctly formatted and appropriate for documentation organisation.docs/web-console-docs/creating-an-experiment.mdx (1)
108-108: Image file verified and present.The image file
static/img/experiment-create/step-3-audience.pngexists in the repository. No issues found.
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (5)
docs/web-console-docs/creating-an-experiment.mdx (5)
9-9: ** Fix hyphenation in compound adjective.**This issue was flagged in the previous review. Line 9 should use a hyphenated compound adjective:
- A step by step guide to creating a new experiment in ABsmartly. + A step-by-step guide to creating a new experiment in ABsmartly.This correction should also be applied to lines 39, 64, and 201 for similar compound terms ("human-readable", "set-up", "decision-making").
39-39: ** Fix hyphenation: "human readable" → "human-readable".**Compound adjective requiring hyphenation (previously flagged):
- As this name will be used to identify your experiment in ABsmartly, we recommend using a good human readable name. + As this name will be used to identify your experiment in ABsmartly, we recommend using a good human-readable name.
64-64: ** Fix hyphenation: "set up" → "set-up".**Used as a noun here, requiring hyphenation (previously flagged):
- The optimal set up is an A/B experiment with a 50/50 split in traffic. + The optimal set-up is an A/B experiment with a 50/50 split in traffic.
201-201: ** Fix hyphenation: "decision making" → "decision-making".**Compound noun requiring hyphenation (previously flagged):
- **Exploratory Metrics** are simply used for curiosity. They should have no impact on the decision making process. + **Exploratory Metrics** are simply used for curiosity. They should have no impact on the decision-making process.
167-168: ** Fix malformed sentence: resolve dangling phrase and duplicate text.**This critical issue was flagged in the previous review. The sentence is broken across lines with a dangling "on the" and duplicate "The primary":
Current text:
If you observe a significant impact on the primary metric but no significant differences on the secondary metrics then the impact observed on the
The primary metric is likely a false positive.Should be:
- If you observe a significant impact on the primary metric but no significant differences on the secondary metrics then the impact observed on the - The primary metric is likely a false positive. For more information, check our article on interpreting results and making decisions. + If you observe a significant impact on the primary metric but no significant differences on the secondary metrics, then the impact observed on the primary metric is likely a false positive. For more information, check our article on interpreting results and making decisions.
🧹 Nitpick comments (2)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx (1)
32-36: Minor: Restructure intro to intro section.The introductory phrase "What you need to know about
Goal Countmetrics." creates slight awkwardness with the following bullet points. Consider removing it or rephrasing to "Key considerations forGoal Countmetrics:" for smoother flow.- ## Good to know - - What you need to know about `Goal Count` metrics. - - - Good for measuring total activity volume. + ## Good to know + + - Good for measuring total activity volume.docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (1)
20-20: Add missing comma for clarity.Line 20 reads awkwardly without a comma after the introductory clause:
- In this page we try to explain the most important attributes and what they mean in the context of experimentation. + In this page, we try to explain the most important attributes and what they mean in the context of experimentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/web-console-docs/creating-an-experiment.mdx(4 hunks)docs/web-console-docs/goals-and-metrics/goals/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/property.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/overview.mdx(9 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/web-console-docs/goals-and-metrics/goals/create.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...d** made by visitors. Using a metric's filter it is also possible to create `Total pu...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~36-~36: To form a complete sentence, be sure to include a subject.
Context: .... - Simple to understand and compute. - Can be skewed by heavy users who trigger th...
(MISSING_IT_THERE)
docs/web-console-docs/creating-an-experiment.mdx
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...s experiment, assign it to a particular team and add tags to help with searching and...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...riment, what you hope for the result to be and what will be done after any of the ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...er visitor, or click-through rate`. Metrics can represent direct business outcomes,...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~20-~20: It appears that a comma is missing.
Context: ...ning those attributes together. In this page we try to explain the most important at...
(DURING_THAT_TIME_COMMA)
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ...te-calls_to_customer_support` #### Behavioural Behavioural metrics are metrics measuring the imp...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~74-~74: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ange and as such have high sensitivity. Behavioural metrics are often used as secondary met...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[duplication] ~81-~81: Possible typo: you repeated a word.
Context: ...on_banner-product_page_views` #### Operational Operational metrics, also known as technical metr...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~82-~82: Possible missing comma found.
Context: ...metrics can be used as guardrail metrics but also possibly as primary or secondary m...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~92-~92: Possible typo: you repeated a word.
Context: ... data is structured and measured. #### Binomial Binomial metrics represent a binary outcome fo...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ... churn_rate - email_open_rate #### Continuous Continuous metrics on the other hand can take on...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~114-~114: Possible typo: you repeated a word.
Context: ... short-term or long-term. #### Short-term Short-term metrics refer to metrics that measure...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~136-~136: Possible typo: you repeated a word.
Context: ...n the context of the experiment. #### Proxy Proxy metrics are indirect measures used to...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...example of long-term metrics above). In experimentation proxy metrics can be used as a replacem...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...lation between the proxy and the actual goal and this should be validated frequently...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~143-~143: Possible typo: you repeated a word.
Context: ...button` as a proxy for conversion #### Composite Composite metrics combine multiple individual m...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~146-~146: The plural noun “combinations” cannot be used with the article “a”. Did you mean “a weighted combination” or “weighted combinations”?
Context: ...Overall Evaluation Criterion (OEC) as a weighted combinations of metrics like engagement, revenue, an...
(A_NNS)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[misspelling] ~13-~13: Did you mean “be”?
Context: ...** | This metric's name. This name must bee unique across the entire platform. | | ...
(BEE_BE)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...style metrics. - More stable than total counts since each user counts once. - Does not...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx
[uncategorized] ~24-~24: Possible missing preposition found.
Context: ...A possible Time to Achievement metric create from this event could be `Time to first...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~29-~29: To form a complete sentence, be sure to include a subject.
Context: ...ction and delays in the user journey. - Can be skewed by users who never reach the ...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (2)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/property.mdx (1)
1-29: ✓ Content looks good.This documentation page is well-structured with clear sections, a relevant code example, and practical guidance. No issues identified.
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx (1)
1-33: ✓ Content is well-structured.The page is clear and follows the same structure as related metric-type documentation. The static analysis hint about a missing comma at line 32 is a stylistic consideration for bullet-list formatting and does not materially affect clarity.
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx
Outdated
Show resolved
Hide resolved
docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ### Purpose | ||
| A metrics can be described as a **business** metric, a **behavioural** metric or an **operational** metrics. | ||
| Those attributes describe the purpose of the metric, what it is measuring.= |
There was a problem hiding this comment.
Fix typo: remove "=" at end of line.
Line 62 has a stray equals sign that appears to be a formatting error:
- Those attributes describe the purpose of the metric, what it is measuring.=
+ Those attributes describe the purpose of the metric, what it is measuring.📝 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.
| Those attributes describe the purpose of the metric, what it is measuring.= | |
| Those attributes describe the purpose of the metric, what it is measuring. |
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 62,
there is a stray "=" character at the end of the line ("Those attributes
describe the purpose of the metric, what it is measuring.="); remove the
trailing "=" (and any accidental trailing whitespace) so the sentence reads
correctly without the extra character.
| #### Composite | ||
| **Composite** metrics combine multiple individual metrics into one measure to capture a nuanced view of success. They are often used strategically but can dilute sensitivity. | ||
| Examples: | ||
| - `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction |
There was a problem hiding this comment.
Fix article-noun agreement: "a weighted combinations" → "weighted combinations".
Line 146 has a grammatical error with mismatched article and noun number:
- `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction
+ `Overall Evaluation Criterion` (OEC) as weighted combinations of metrics like engagement, revenue, and satisfaction📝 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.
| - `Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction | |
| - `Overall Evaluation Criterion` (OEC) as weighted combinations of metrics like engagement, revenue, and satisfaction |
🧰 Tools
🪛 LanguageTool
[grammar] ~146-~146: The plural noun “combinations” cannot be used with the article “a”. Did you mean “a weighted combination” or “weighted combinations”?
Context: ...Overall Evaluation Criterion (OEC) as a weighted combinations of metrics like engagement, revenue, an...
(A_NNS)
🤖 Prompt for AI Agents
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 146:
the phrase reads "a weighted combinations" which has an incorrect article-number
agreement; remove the extraneous "a" so the phrase becomes "weighted
combinations" (i.e., replace "a weighted combinations of metrics like..." with
"weighted combinations of metrics like...").
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx (1)
23-23: Fix grammar error: "purchased" → "purchases"This issue was previously flagged. The sentence should read: "...count all the purchases made by visitors."
- This metric would simply **count all the purchased** made by visitors. + This metric would simply **count all the purchases** made by visitors.docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx (1)
22-22: Fix grammar error: "metric create" → "metric created"This issue was previously flagged. The sentence requires the past participle form.
- A possible `Time to Achievement` metric create from this event could be `Time to first purchase`. + A possible `Time to Achievement` metric created from this event could be `Time to first purchase`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/web-console-docs/Configuration/settings.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/goals/overview.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/property.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/web-console-docs/goals-and-metrics/metrics/metric-types/property.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/web-console-docs/Configuration/settings.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...the metric. This information is version-specific and as such can differ between differen...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~33-~33: The plural determiner ‘these’ does not agree with the singular noun ‘application’.
Context: ...akes sense. Only experiments running on these application should track this metric. | | Units...
(THIS_NNS)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx
[typographical] ~13-~13: Consider adding a colon here.
Context: ...at to observe in the experiment. Goals are the raw data used to compute [Metrics](../m...
(MY_QUESTION_IS_COLON)
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...se** was triggered. To learn more about events you can read the dedicated page [Goal E...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...d** made by visitors. Using a metric's filter it is also possible to create `Total pu...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~34-~34: To form a complete sentence, be sure to include a subject.
Context: .... - Simple to understand and compute. - Can be skewed by heavy users who trigger th...
(MISSING_IT_THERE)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...style metrics. - More stable than total counts since each user counts once. - Does not...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx
[uncategorized] ~22-~22: Possible missing preposition found.
Context: ...A possible Time to Achievement metric create from this event could be `Time to first...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~27-~27: To form a complete sentence, be sure to include a subject.
Context: ...ction and delays in the user journey. - Can be skewed by users who never reach the ...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (6)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx (1)
26-26: Fix noun agreement: "purchase" → "purchases".The metric counts multiple purchases; the noun should be plural to match the quantity.
- In this case, the metric would count all the purchase of product from category ZYZ123. + In this case, the metric would count all the purchases of products from category ZYZ123.docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-unique-count.mdx (1)
1-31: Documentation is well-structured and clear.The page follows the established metric-type template, provides clear definitions, relevant examples, and actionable guidance. No changes needed.
docs/web-console-docs/goals-and-metrics/goals/overview.mdx (1)
31-31: Add missing comma and remove redundant wording.The introductory clause needs a comma for proper punctuation, and "page" should not appear twice.
- To learn more about events you can read the dedicated page [Goal Events page](../../events/goal-events) in the knowledge base. + To learn more about events, you can read the dedicated [Goal Events page](../../events/goal-events) in the knowledge base.docs/web-console-docs/goals-and-metrics/metrics/create.mdx (3)
24-24: Add missing comma for improved clarity.A comma after "as such" improves readability and proper punctuation of the compound clause.
- This information is version-specific and as such can differ between different versions of the same metric. + This information is version-specific and, as such, can differ between different versions of the same metric.
28-28: Fix subject agreement: "experiment" → "experiments".The sentence context refers to multiple experiments; the noun should be plural to match.
- | **Description** | The metric's description. Providing a good description is important as it helps experiment choose the right metric.| + | **Description** | The metric's description. Providing a good description is important as it helps experiments choose the right metric.|
33-33: Fix noun agreement: "application" → "applications".The plural determiner "these" requires a plural noun.
- | **Applications** (optional)| Select the [applications](../../configuration/applications) where this metric makes sense. Only experiments running on these application should track this metric. | + | **Applications** (optional)| Select the [applications](../../configuration/applications) where this metric makes sense. Only experiments running on these applications should track this metric. |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
31-34: Standardise internal link path formats.Lines 31–34 use inconsistent path formats: line 31 uses an absolute path (
/docs/web-console-docs/...), whilst lines 33–34 use relative paths (../../configuration/...). For maintainability and clarity, standardise on one format throughout the documentation.If relative paths are the project convention, update line 31 to:
-| **Tags** (optional)| Makes the metric more discoverable by providing relevant [tags](/docs/web-console-docs/configuration/settings#tags).| +| **Tags** (optional)| Makes the metric more discoverable by providing relevant [tags](../../configuration/settings#tags).|
24-24: Consider adding comma after introductory phrase.Line 24 reads: "This information is version-specific and as such can differ between different versions of the same metric." For improved readability, consider adding a comma after "as such":
-This information is version-specific and as such can differ between different versions of the same metric. +This information is version-specific and as such, can differ between different versions of the same metric.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...the metric. This information is version-specific and as such can differ between differen...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~33-~33: The plural determiner ‘these’ does not agree with the singular noun ‘application’.
Context: ...akes sense. Only experiments running on these application should track this metric. | | Units...
(THIS_NNS)
[typographical] ~38-~38: It appears that a comma is missing.
Context: ...elevant & computed. | ## Goal In this section you can select the [goal](../goals/over...
(DURING_THAT_TIME_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (1)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx (1)
31-31: Fix case-sensitive internal link path.The directory is named
Events(uppercase), but the link uses lowercase. This will result in a broken link on the documentation site:-To learn more about `events` you can read the dedicated [Goal Events page](../../events/goal-events) in the knowledge base. +To learn more about `events` you can read the dedicated [Goal Events page](../../Events/goal-events) in the knowledge base.
🧹 Nitpick comments (1)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx (1)
25-25: Consider adding a comma for improved readability.Line 25 would benefit from a comma after the introductory phrase: "Using a metric's filter, it is also possible to create..." This improves sentence flow, though the current phrasing is grammatically acceptable.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/web-console-docs/goals-and-metrics/goals/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/goals/overview.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/goals/overview.mdx
[typographical] ~13-~13: Consider adding a colon here.
Context: ...at to observe in the experiment. Goals are the raw data used to compute [Metrics](../m...
(MY_QUESTION_IS_COLON)
[grammar] ~40-~40: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~40-~40: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~94-~94: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...h other teams and individual across the organisation. | Permission | Description | |-------...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...cations should track this metric. While optional setting the correct Application(s) ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ... experiments where it is tracked. While optional setting the correct **Tracking Unit(s)*...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~38-~38: It appears that a comma is missing.
Context: ... their experiments. | ## Goal In this section you can select and configure the [goal]...
(DURING_THAT_TIME_COMMA)
[grammar] ~56-~56: After ‘it’, use the third-person verb form “exists”.
Context: ...'t see a goal in the list, make sure it exist and make sure you have the correct perm...
(IT_VBZ)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...ts in the experiment. Using a metric's filter it is also possible to create `Total pu...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~34-~34: To form a complete sentence, be sure to include a subject.
Context: .... - Simple to understand and compute. - Can be skewed by heavy users who trigger th...
(MISSING_IT_THERE)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx
[style] ~27-~27: To form a complete sentence, be sure to include a subject.
Context: ...ction and delays in the user journey. - Can be skewed by users who never reach the ...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (5)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/time-to-achievement.mdx (2)
22-22: Grammar issue from previous review has been resolved.The sentence now correctly uses "metric created" instead of "metric create".
26-28: Bullet‑point style is appropriate; static analysis flag is a false positive.Bullet points commonly omit subjects as a standard documentation convention. The "Good to know" section is clear and well‑formatted.
docs/web-console-docs/goals-and-metrics/metrics/metric-types/goal-count.mdx (2)
23-23: Past grammar concern has been resolved.The previous review flagged a grammatical error on this line, which has been correctly updated to "count all the purchases" (not "purchased"). ✓
7-34: Solid documentation structure and content.The Overview clearly explains the purpose, the Examples section provides a concrete JavaScript snippet with practical use cases (including filtering), and the Good to know section offers relevant guidance. The content is well-organised, accessible, and should help users understand when and how to apply Goal Count metrics.
docs/web-console-docs/goals-and-metrics/goals/create.mdx (1)
1-37: Prior feedback has been satisfactorily addressed.The previous grammar corrections (subject-verb agreement on line 23 and missing comma on line 32) have been implemented. The file is well-structured with clear sections, properly formatted tables, and appropriate cross-references.
| | **Team Viewer** | Grant ability to view and list Goals owned by the team. | | ||
|
|
||
| :::info | ||
| Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams. |
There was a problem hiding this comment.
Add missing comma in conditional clause.
Line 89 needs a comma after the conditional "if" clause to separate it from the main clause:
-Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams.
+Team roles are inherited, so if a user is a `Team Contributor` in a team, then this user would also be a `Team Contributor` in all child teams.📝 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.
| Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams. | |
| Team roles are inherited, so if a user is a `Team Contributor` in a team, then this user would also be a `Team Contributor` in all child teams. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~89-~89: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
docs/web-console-docs/goals-and-metrics/goals/overview.mdx around line 89: the
conditional clause lacks a comma before the main clause; add a comma after "if a
user is a `Team Contributor` in a team" so the sentence reads with a comma
separating the conditional and main clause (i.e., insert ", " after that
phrase).
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (3)
56-56: Fix verb agreement: use "exists" for third-person singular.The verb must agree with the singular subject "it".
-If you don't see a goal in the list, make sure it exist and make sure you have the correct permissions to view and use it. +If you don't see a goal in the list, make sure it exists and make sure you have the correct permissions to view and use it.
18-18: Fix number agreement: use plural "versions".Line 18 should use the plural form "versions" to match the context of multiple metric versions.
-Future changes to those fields will apply to all existing and future version of a metric. +Future changes to those fields will apply to all existing and future versions of a metric.
33-34: Add missing commas after "optional".Both lines need commas to separate the introductory clause from the main instruction:
-| **Applications** (optional)| Select the [applications](../../configuration/applications) where this metric makes sense. Only experiments running on these applications should track this metric. While optional setting the correct **Application(s)** helps experimenters find relevant metrics for their experiments. | +| **Applications** (optional)| Select the [applications](../../configuration/applications) where this metric makes sense. Only experiments running on these applications should track this metric. While optional, setting the correct **Application(s)** helps experimenters find relevant metrics for their experiments. |-| **Units** (optional)| Select the [tracking units](../../configuration/units) for which this metric is computed. The tracking unit of the metric should match the tracking unit of the experiments where it is tracked. While optional setting the correct **Tracking Unit(s)** will help experimenters track relevant metrics in their experiments. | +| **Units** (optional)| Select the [tracking units](../../configuration/units) for which this metric is computed. The tracking unit of the metric should match the tracking unit of the experiments where it is tracked. While optional, setting the correct **Tracking Unit(s)** will help experimenters track relevant metrics in their experiments. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...cations should track this metric. While optional setting the correct Application(s) ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ... experiments where it is tracked. While optional setting the correct **Tracking Unit(s)*...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~38-~38: It appears that a comma is missing.
Context: ... their experiments. | ## Goal In this section you can select and configure the [goal]...
(DURING_THAT_TIME_COMMA)
[grammar] ~56-~56: After ‘it’, use the third-person verb form “exists”.
Context: ...'t see a goal in the list, make sure it exist and make sure you have the correct perm...
(IT_VBZ)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (1)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (1)
31-31: Verify link format consistency.This line uses an absolute path (
/docs/web-console-docs/configuration/settings#tags) whilst other links in the table use relative paths (e.g.,../../configuration/applicationson line 33). Ensure consistency with the project's link conventions.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (1)
23-23: Fix plural form: "details" not "detail".The section header refers to multiple pieces of information, so use the plural form.
-The Metric detail and Metadata sections provide some advanced information about the metric. +The Metric details and Metadata sections provide some advanced information about the metric.docs/web-console-docs/goals-and-metrics/goals/overview.mdx (2)
40-40: Fix multiple grammar errors.Line 40 contains two critical grammar issues:
- "can owned" should use the auxiliary verb form: "can be owned"
- "was enable" should use the past participle: "was enabled"
-A goal can owned by 1 or more teams and, if the feature was enable for your organisation, individual users. +A goal can be owned by 1 or more teams and, if the feature was enabled for your organisation, individual users.
89-89: Add missing comma after the conditional clause.A comma is required after the "if" clause to properly separate it from the main clause.
-Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams. +Team roles are inherited, so if a user is a `Team Contributor` in a team, then this user would also be a `Team Contributor` in all child teams.
🧹 Nitpick comments (4)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (4)
13-13: Improve phrase clarity in table description.The phrase "This name of the metric" is awkward. Use either "The name of the metric" or "This metric's name" for better readability.
-| **Metric name** | This name of the metric must be unique across the entire platform. | +| **Metric name** | The name of the metric must be unique across the entire platform. |
38-38: Add missing comma after introductory phrase.A comma is required after "In this section" when introducing an independent clause.
-In this section you can select and configure the [goal](../goals/overview) which provides the raw data for this metric. +In this section, you can select and configure the [goal](../goals/overview) which provides the raw data for this metric.
73-73: Fix spelling: "relevent" → "relevant".-in that case a **category_id** property filter can be used to filter only the relevent **purchases** events. +in that case a **category_id** property filter can be used to filter only the relevant **purchases** events.
166-166: Add space after markdown heading marker.Markdown headers should have a space between the hash symbols and the heading text for proper formatting.
-####Fixed +#### Fixed
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/web-console-docs/goals-and-metrics/goals/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/goals/overview.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/web-console-docs/goals-and-metrics/goals/create.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/goals/overview.mdx
[typographical] ~13-~13: Consider adding a colon here.
Context: ...at to observe in the experiment. Goals are the raw data used to compute [Metrics](../m...
(MY_QUESTION_IS_COLON)
[grammar] ~40-~40: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~40-~40: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~94-~94: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...h other teams and individual across the organisation. | Permission | Description | |-------...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[typographical] ~38-~38: It appears that a comma is missing.
Context: ... their experiments. | ## Goal In this section you can select and configure the [goal]...
(DURING_THAT_TIME_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (2)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx (2)
1-100: Overall documentation structure is clear and well-organised.The content effectively introduces Goals, demonstrates Goal Events with a concrete code example, and provides comprehensive permission tables. The hierarchy and use of info blocks enhance readability. Once the grammar and link path issues above are resolved, this page will provide solid documentation.
31-31: Correct the case sensitivity in the internal link path.The directory is named
Events(uppercase), but the link uses lowercaseevents. This will cause the link to break in case-sensitive file systems.Change
../../events/goal-eventsto../../Events/goal-eventson Line 31.-To learn more about `events` you can read the dedicated [Goal Events page](../../events/goal-events) in the knowledge base. +To learn more about `events` you can read the dedicated [Goal Events page](../../Events/goal-events) in the knowledge base.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (1)
23-23: Fix plural form: "Details" not "detail".Line 23 contains a grammatical error where the singular "detail" should be plural "Details" to match the section header context.
-The Metric detail and Metadata sections provide some advanced information about the metric. +The Metric Details and Metadata sections provide some advanced information about the metric.Note: This issue was flagged in previous review comments as addressed in commit e97cfe9, but it remains in the current code.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[typographical] ~38-~38: It appears that a comma is missing.
Context: ... their experiments. | ## Goal In this section you can select and configure the [goal]...
(DURING_THAT_TIME_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (2)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
85-184: Well-structured outlier methods documentation.The Outliers section with its four subsections (Unlimited, Quantile, Standard Deviation, Fixed) is clearly written with helpful examples and code blocks. The warning admonition appropriately contextualises the risks of outlier handling.
185-189: Clarify the incomplete sections.The final three section headers (Goal Relations, Format scale and precisions, Metric threshold alert) contain no body content. Please confirm whether these are intentional placeholders for future content or if they need to be populated or removed.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (3)
23-23: Fix plural form: "details" not "detail".This was previously flagged but appears unresolved.
-The Metric detail and Metadata sections provide some advanced information about the metric. +The Metric details and Metadata sections provide some advanced information about the metric.
38-38: Add missing comma after introductory phrase.This was previously flagged but appears unresolved.
-In this section you can select and configure the [goal](../goals/overview) which provides the raw data for this metric. +In this section, you can select and configure the [goal](../goals/overview) which provides the raw data for this metric.
73-73: Fix typo: "relevent" → "relevant".This was previously flagged but appears unresolved.
-in that case a **category_id** property filter can be used to filter only the relevent **purchases** events. +in that case a **category_id** property filter can be used to filter only the relevant **purchases** events.
🧹 Nitpick comments (2)
docs/web-console-docs/Events/downloading-events.mdx (2)
22-22: Add missing comma for improved readability.Line 22 would benefit from a comma after the introductory clause: "When the export file is ready, a notification will show on the report's activity tab."
- When the export file is ready a notification will show on the report's activity tab. + When the export file is ready, a notification will show on the report's activity tab.
73-73: Consider adding a comma for improved clarity.Line 73 describes compression options and could benefit from a comma after "faster" to improve readability: "ZSTD is similar to GZIP in compression level but faster, and less widely supported."
- | **Compression** | The compression method to use. GZIP is widely supported and provides good compression. ZSTD is similar to GZIP in compression level but faster, and less widely supported. LZ4 is much faster but provides slightly less compression. None is no compression. | + | **Compression** | The compression method to use. GZIP is widely supported and provides good compression. ZSTD is similar to GZIP in compression level but faster and less widely supported. LZ4 is much faster but provides slightly less compression. None is no compression. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/web-console-docs/Events/downloading-events.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[typographical] ~38-~38: It appears that a comma is missing.
Context: ... their experiments. | ## Goal In this section you can select and configure the [goal]...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~204-~204: Possible missing article found.
Context: ...hases which were not cancelled, giving experimenter a more accurate view of the actual busi...
(AI_HYDRA_LEO_MISSING_THE)
[typographical] ~277-~277: After the expression ‘for example’ a comma is usually used.
Context: ...ld override or adjust the original. For example replacement_price. Duplicated foreign ...
(COMMA_FOR_EXAMPLE)
docs/web-console-docs/Events/downloading-events.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...ynchronously. - When the export file is ready a notification will show on the report'...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: Possible missing comma found.
Context: ... is similar to GZIP in compression level but faster, and less widely supported. LZ4 ...
(AI_HYDRA_LEO_CPT_BUT_CBUT)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (1)
docs/web-console-docs/Events/downloading-events.mdx (1)
54-54: Verify the cross-reference link.Line 54 references
[Event Filters section](#event-filters), but this section does not appear to exist in the current file. Confirm whether this link should reference a section in another file (such asthe-events-page.mdx) and adjust the link accordingly.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
207-207: Correct noun number agreement: "experimenter" → "experimenters".The phrase uses a plural subject ("purchases which were not cancelled") but refers to singular "experimenter". Change to plural for consistency:
-giving experimenter a more accurate view of the actual business impact of their changes. +giving experimenters a more accurate view of the actual business impact of their changes.
309-309: Add missing comma after "For example".-Value from the replacement event that should override or adjust the original. For example replacement_price. +Value from the replacement event that should override or adjust the original. For example, replacement_price.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
static/img/metrics/goal-relation-cancellation.pngis excluded by!**/*.pngstatic/img/metrics/goal-relation-refund.pngis excluded by!**/*.pngstatic/img/metrics/goal-relation-replacement.pngis excluded by!**/*.pngstatic/img/metrics/lower-alert-threshold.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/web-console-docs/Events/downloading-events.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/web-console-docs/Events/downloading-events.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~207-~207: Possible missing article found.
Context: ...hases which were not cancelled, giving experimenter a more accurate view of the actual busi...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~276-~276: Possible missing comma found.
Context: ...revenue reflect the impact of refunds accurately providing a more accurate view on the i...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~309-~309: After the expression ‘for example’ a comma is usually used.
Context: ...ld override or adjust the original. For example replacement_price. - Duplicated foreign...
(COMMA_FOR_EXAMPLE)
[uncategorized] ~334-~334: Possible missing comma found.
Context: ...ul. In this case and to prevent further loss it might be worth stopping the experime...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (1)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (1)
34-34: Verify link path format consistency.Line 34 uses an absolute path
/docs/web-console-docs/configuration/settings#tagswhilst other internal links in the file use relative paths (e.g. line 33:[metric-types/goal-count], line 36:[../../configuration/applications]). Confirm this intentional or align with relative path format used elsewhere.
| - Duplicated foreign goal aggregation | ||
| Determines how to combine multiple refund events referring to the same item (sum, max, last, etc.). | ||
|
|
||
| This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change. |
There was a problem hiding this comment.
Add missing comma for readability: comma after "accurately".
-This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change.
+This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately, providing a more accurate view on the impact of the change.📝 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.
| This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change. | |
| This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately, providing a more accurate view on the impact of the change. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~276-~276: Possible missing comma found.
Context: ...revenue reflect the impact of refunds accurately providing a more accurate view on the i...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/create.mdx around line 276,
add a comma after the word "accurately" in the sentence so it reads "...reflect
the impact of refunds accurately, providing a more accurate view on the impact
of the change." to improve readability.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
430-430: Add missing commas in compound sentence structure.Line 430 requires commas to separate the introductory phrase from the main clause:
-In this case and to prevent further loss it might be worth stopping the experiment and investigating what is happening. +In this case, and to prevent further loss, it might be worth stopping the experiment and investigating what is happening.
282-282: Add missing comma for grammatical correctness.Line 282 contains a compound sentence missing a comma before the participial phrase "providing":
-This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change. +This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately, providing a more accurate view on the impact of the change.docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (1)
146-146: Fix article agreement with plural noun.Line 146 uses singular article "a" with plural noun "combinations". Remove the article to match the plural form:
-`Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction +`Overall Evaluation Criterion` (OEC) as weighted combinations of metrics like engagement, revenue, and satisfaction
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/overview.mdx(9 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~282-~282: Possible missing comma found.
Context: ...revenue reflect the impact of refunds accurately providing a more accurate view on the i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~338-~338: Would you like to use the Oxford spelling “customize”? The spelling ‘customise’ is also correct.
Context: ...maxWidth="50rem" centered /> You can customise three aspects for both Value and **...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~430-~430: Possible missing comma found.
Context: ...ul. In this case and to prevent further loss it might be worth stopping the experime...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...er visitor, or click-through rate`. Metrics can represent direct business outcomes,...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~20-~20: It appears that a comma is missing.
Context: ...ning those attributes together. In this page we try to explain the most important at...
(DURING_THAT_TIME_COMMA)
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ...te-calls_to_customer_support` #### Behavioural Behavioural metrics are metrics measuring the imp...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~74-~74: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ange and as such have high sensitivity. Behavioural metrics are often used as secondary met...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[duplication] ~81-~81: Possible typo: you repeated a word.
Context: ...on_banner-product_page_views` #### Operational Operational metrics, also known as technical metr...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~82-~82: Possible missing comma found.
Context: ...metrics can be used as guardrail metrics but also possibly as primary or secondary m...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~92-~92: Possible typo: you repeated a word.
Context: ... data is structured and measured. #### Binomial Binomial metrics represent a binary outcome fo...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ... churn_rate - email_open_rate #### Continuous Continuous metrics on the other hand can take on...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~114-~114: Possible typo: you repeated a word.
Context: ... short-term or long-term. #### Short-term Short-term metrics refer to metrics that measure...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~136-~136: Possible typo: you repeated a word.
Context: ...n the context of the experiment. #### Proxy Proxy metrics are indirect measures used to...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...example of long-term metrics above). In experimentation proxy metrics can be used as a replacem...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...lation between the proxy and the actual goal and this should be validated frequently...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~143-~143: Possible typo: you repeated a word.
Context: ...button` as a proxy for conversion #### Composite Composite metrics combine multiple individual m...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~146-~146: The plural noun “combinations” cannot be used with the article “a”. Did you mean “a weighted combination” or “weighted combinations”?
Context: ...Overall Evaluation Criterion (OEC) as a weighted combinations of metrics like engagement, revenue, an...
(A_NNS)
[style] ~160-~160: ‘refer back’ might be wordy. Consider a shorter alternative.
Context: ...sparent and reproducible You can always refer back to earlier versions and understand exac...
(EN_WORDINESS_PREMIUM_REFER_BACK)
[style] ~160-~160: This phrase is redundant. Consider writing “point” or “time”.
Context: ...tly how a metric was constructed at any point in time. - Teams can evolve metrics safely You ...
(MOMENT_IN_TIME)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
| A metrics can be described as a **business** metric, a **behavioural** metric or an **operational** metrics. | ||
| Those attributes describe the purpose of the metric, what it is measuring.= |
There was a problem hiding this comment.
Fix article–noun agreement and remove stray character.
Two issues on consecutive lines:
- Line 61: Singular article "A" does not agree with plural noun "metrics":
-A metrics can be described as a **business** metric, a **behavioural** metric or an **operational** metrics.
+A metric can be described as a **business** metric, a **behavioural** metric or an **operational** metric.- Line 62: Stray equals sign at end of line:
-Those attributes describe the purpose of the metric, what it is measuring.=
+Those attributes describe the purpose of the metric, what it is measuring.📝 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.
| A metrics can be described as a **business** metric, a **behavioural** metric or an **operational** metrics. | |
| Those attributes describe the purpose of the metric, what it is measuring.= | |
| A metric can be described as a **business** metric, a **behavioural** metric or an **operational** metric. | |
| Those attributes describe the purpose of the metric, what it is measuring. |
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around lines
61–62, fix the article–noun agreement and remove the stray '=': replace the
incorrect sentence "A metrics can be described as a **business** metric, a
**behavioural** metric or an **operational** metrics." with a grammatically
correct version such as "Metrics can be described as business, behavioural, or
operational metrics." and remove the trailing '=' character at the end of the
following line.
There was a problem hiding this comment.
Actionable comments posted: 8
♻️ Duplicate comments (7)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx (3)
31-31: Fix internal link path: use capital "E" in Events directory.The directory is named
Events(uppercase), but the link uses lowercaseevents. This will cause the link to fail.-To learn more about `events` you can read the dedicated [Goal Events page](../../events/goal-events) in the knowledge base. +To learn more about `events` you can read the dedicated [Goal Events page](../../Events/goal-events) in the knowledge base.
40-40: Fix grammar: verb phrase and past participle agreement.Line 40 contains two grammar errors:
- "can owned" should be "can be owned" (missing auxiliary verb)
- "was enable" should be "was enabled" (past participle required)
-A goal can owned by 1 or more teams and, if the feature was enable for your organisation, individual users. +A goal can be owned by 1 or more teams and, if the feature was enabled for your organisation, individual users.
89-89: Add missing comma in conditional clause.The conditional "if" clause should be separated from the main clause by a comma for proper punctuation.
-Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams. +Team roles are inherited, so if a user is a `Team Contributor` in a team, then this user would also be a `Team Contributor` in all child teams.docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (2)
61-62: Fix subject-verb agreement and remove stray character.Two issues on consecutive lines:
- Line 61: Singular article and plural noun do not agree
- Line 62: Stray equals sign at end of line
-A metrics can be described as a **business** metric, a **behavioural** metric or an **operational** metrics. -Those attributes describe the purpose of the metric, what it is measuring.= +Metrics can be described as **business**, **behavioural**, or **operational** metrics. +Those attributes describe the purpose of the metric, what it is measuring.
146-146: Fix article–noun agreement.The plural noun "combinations" cannot be used with the singular article "a".
-`Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction +`Overall Evaluation Criterion` (OEC) as weighted combinations of metrics like engagement, revenue, and satisfactiondocs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
430-430: Add missing commas for proper compound sentence punctuation.The sentence requires commas to properly separate clauses and parenthetical elements.
-In this case and to prevent further loss it might be worth stopping the experiment and investigating what is happening. +In this case, and to prevent further loss, it might be worth stopping the experiment and investigating what is happening.
282-282: Add missing comma for readability.Insert a comma after "accurately" to properly separate the participial phrase.
-This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change. +This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately, providing a more accurate view on the impact of the change.
🧹 Nitpick comments (1)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (1)
160-160: Reduce wordiness and redundancy.Consider more concise alternatives to reduce unnecessary verbiage.
-You can always refer back to earlier versions and understand exactly how a metric was constructed at any point in time. +You can always refer to earlier versions and understand exactly how a metric was constructed at any time.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/overview.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...er visitor, or click-through rate`. Metrics can represent direct business outcomes,...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~20-~20: It appears that a comma is missing.
Context: ...ning those attributes together. In this page we try to explain the most important at...
(DURING_THAT_TIME_COMMA)
[style] ~27-~27: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...change achieves its desired outcome and whether or not the hypothesis is validated or rejected...
(WHETHER)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...context and insights beyond the primary metric and can help detect unintended side eff...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ...te-calls_to_customer_support` #### Behavioural Behavioural metrics are metrics measuring the imp...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~74-~74: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ange and as such have high sensitivity. Behavioural metrics are often used as secondary met...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[duplication] ~81-~81: Possible typo: you repeated a word.
Context: ...on_banner-product_page_views` #### Operational Operational metrics, also known as technical metr...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~82-~82: Possible missing comma found.
Context: ...metrics can be used as guardrail metrics but also possibly as primary or secondary m...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~92-~92: Possible typo: you repeated a word.
Context: ... data is structured and measured. #### Binomial Binomial metrics represent a binary outcome fo...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ... churn_rate - email_open_rate #### Continuous Continuous metrics on the other hand can take on...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~103-~103: Consider separating this adverbial phrase with commas.
Context: ... #### Continuous Continuous metrics on the other hand can take on a wide range of values (eit...
(ON_THE_OTHER_HAND_COMMA)
[uncategorized] ~103-~103: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r range of data) and offer more insights but they can be heavily influenced by outli...
(COMMA_COMPOUND_SENTENCE)
[duplication] ~114-~114: Possible typo: you repeated a word.
Context: ... short-term or long-term. #### Short-term Short-term metrics refer to metrics that measure...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~124-~124: Possible missing comma found.
Context: ..., long-term metrics measure delayed outcomes which make it hard to measure during th...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~124-~124: To elevate your writing, try using a synonym here.
Context: ... measure delayed outcomes which make it hard to measure during the runtime of an exp...
(HARD_TO)
[uncategorized] ~124-~124: A comma may be missing after the conjunctive/linking adverb ‘Typically’.
Context: ...re during the runtime of an experiment. Typically long-term metrics represent the strateg...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~125-~125: The noun “decision-making” (= the process of deciding something) is spelled with a hyphen.
Context: ...iness outcomes. Using such a metric for decision making requires adapting the experiment design...
(DECISION_MAKING)
[uncategorized] ~125-~125: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e experiment design so it captures this long term impact. Examples: - `true_conversion_...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[duplication] ~136-~136: Possible typo: you repeated a word.
Context: ...n the context of the experiment. #### Proxy Proxy metrics are indirect measures used to...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...example of long-term metrics above). In experimentation proxy metrics can be used as a replacem...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...lation between the proxy and the actual goal and this should be validated frequently...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~143-~143: Possible typo: you repeated a word.
Context: ...button` as a proxy for conversion #### Composite Composite metrics combine multiple individual m...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~146-~146: The plural noun “combinations” cannot be used with the article “a”. Did you mean “a weighted combination” or “weighted combinations”?
Context: ...Overall Evaluation Criterion (OEC) as a weighted combinations of metrics like engagement, revenue, an...
(A_NNS)
[style] ~160-~160: ‘refer back’ might be wordy. Consider a shorter alternative.
Context: ...arent and reproducible: You can always refer back to earlier versions and understand exac...
(EN_WORDINESS_PREMIUM_REFER_BACK)
[style] ~160-~160: This phrase is redundant. Consider writing “point” or “time”.
Context: ...tly how a metric was constructed at any point in time. - Teams can evolve metrics safely: Yo...
(MOMENT_IN_TIME)
[uncategorized] ~181-~181: Possible missing article found.
Context: ...etter enforce ownership and governance, metric's owners must own the entire history of...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~181-~181: Possible missing comma found.
Context: ...owners must own the entire history of a metric including all its past versions. ### E...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~213-~213: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~213-~213: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~257-~257: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~262-~262: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...h other teams and individual across the organisation. | Permission | Description | |-------...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx
[typographical] ~13-~13: Consider adding a colon here.
Context: ...at to observe in the experiment. Goals are the raw data used to compute [Metrics](../m...
(MY_QUESTION_IS_COLON)
[grammar] ~40-~40: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~40-~40: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~94-~94: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...h other teams and individual across the organisation. | Permission | Description | |-------...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~282-~282: Possible missing comma found.
Context: ...revenue reflect the impact of refunds accurately providing a more accurate view on the i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~338-~338: Would you like to use the Oxford spelling “customize”? The spelling ‘customise’ is also correct.
Context: ...maxWidth="50rem" centered /> You can customise three aspects for both Value and **...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~430-~430: Possible missing comma found.
Context: ...ul. In this case and to prevent further loss it might be worth stopping the experime...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
| ## Understanding Experimentation Metrics | ||
|
|
||
| Experimentation metrics can be described using many attributes, often combining those attributes together. | ||
| In this page we try to explain the most important attributes and what they mean in the context of experimentation. |
There was a problem hiding this comment.
Add missing comma after introductory clause.
Insert a comma after the introductory phrase "In this page we try to explain..."
-In this page we try to explain the most important attributes and what they mean in the context of experimentation.
+In this page, we try to explain the most important attributes and what they mean in the context of experimentation.📝 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.
| In this page we try to explain the most important attributes and what they mean in the context of experimentation. | |
| In this page, we try to explain the most important attributes and what they mean in the context of experimentation. |
🧰 Tools
🪛 LanguageTool
[typographical] ~20-~20: It appears that a comma is missing.
Context: ...ning those attributes together. In this page we try to explain the most important at...
(DURING_THAT_TIME_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 20,
the sentence "In this page we try to explain the most important attributes and
what they mean in the context of experimentation." is missing a comma after the
introductory clause; insert a comma after "In this page we try to explain" so
the sentence reads with the correct introductory clause punctuation.
| -` email_open_rate` | ||
|
|
||
| #### Continuous | ||
| **Continuous** metrics on the other hand can take on a wide range of values (either measured or counted). Continuous metrics often represent quantities or durations. Their underlying distribution varies depending on the data. Continuous metrics are more sensitive (they capture a wider range of data) and offer more insights but they can be heavily influenced by outliers and are harder to interpret. |
There was a problem hiding this comment.
Add commas for proper punctuation in compound sentence.
Two corrections needed:
- Add comma after "on the other hand" (adverbial phrase)
- Add comma before "but" (connects independent clauses)
-**Continuous** metrics on the other hand can take on a wide range of values (either measured or counted). Continuous metrics often represent quantities or durations. Their underlying distribution varies depending on the data. Continuous metrics are more sensitive (they capture a wider range of data) and offer more insights but they can be heavily influenced by outliers and are harder to interpret.
+**Continuous** metrics, on the other hand, can take on a wide range of values (either measured or counted). Continuous metrics often represent quantities or durations. Their underlying distribution varies depending on the data. Continuous metrics are more sensitive (they capture a wider range of data) and offer more insights, but they can be heavily influenced by outliers and are harder to interpret.📝 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.
| **Continuous** metrics on the other hand can take on a wide range of values (either measured or counted). Continuous metrics often represent quantities or durations. Their underlying distribution varies depending on the data. Continuous metrics are more sensitive (they capture a wider range of data) and offer more insights but they can be heavily influenced by outliers and are harder to interpret. | |
| **Continuous** metrics, on the other hand, can take on a wide range of values (either measured or counted). Continuous metrics often represent quantities or durations. Their underlying distribution varies depending on the data. Continuous metrics are more sensitive (they capture a wider range of data) and offer more insights, but they can be heavily influenced by outliers and are harder to interpret. |
🧰 Tools
🪛 LanguageTool
[typographical] ~103-~103: Consider separating this adverbial phrase with commas.
Context: ... #### Continuous Continuous metrics on the other hand can take on a wide range of values (eit...
(ON_THE_OTHER_HAND_COMMA)
[uncategorized] ~103-~103: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r range of data) and offer more insights but they can be heavily influenced by outli...
(COMMA_COMPOUND_SENTENCE)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 103,
the sentence is missing two commas: add a comma after the adverbial phrase "on
the other hand," and add a comma before the coordinating conjunction "but" to
separate the independent clauses; update the line to include these two commas so
it reads with proper punctuation.
| On the other hand, **long-term** metrics measure delayed outcomes which make it hard to measure during the runtime of an experiment. | ||
| Typically long-term metrics represent the strategic goals and align with the desired business outcomes. Using such a metric for decision making requires adapting the experiment design so it captures this long term impact. |
There was a problem hiding this comment.
Add missing commas and fix hyphenation.
Three corrections needed:
- Add comma after "Typically" (conjunctive adverb)
- Add comma after "outcomes" (introductory phrase)
- Hyphenate "long-term" when used as compound adjective
-On the other hand, **long-term** metrics measure delayed outcomes which make it hard to measure during the runtime of an experiment.
-Typically long-term metrics represent the strategic goals and align with the desired business outcomes. Using such a metric for decision making requires adapting the experiment design so it captures this long term impact.
+On the other hand, **long-term** metrics measure delayed outcomes, which make it hard to measure during the runtime of an experiment.
+Typically, long-term metrics represent the strategic goals and align with the desired business outcomes. Using such a metric for decision-making requires adapting the experiment design so it captures this long-term impact.📝 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.
| On the other hand, **long-term** metrics measure delayed outcomes which make it hard to measure during the runtime of an experiment. | |
| Typically long-term metrics represent the strategic goals and align with the desired business outcomes. Using such a metric for decision making requires adapting the experiment design so it captures this long term impact. | |
| On the other hand, **long-term** metrics measure delayed outcomes, which make it hard to measure during the runtime of an experiment. | |
| Typically, long-term metrics represent the strategic goals and align with the desired business outcomes. Using such a metric for decision-making requires adapting the experiment design so it captures this long-term impact. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~124-~124: Possible missing comma found.
Context: ..., long-term metrics measure delayed outcomes which make it hard to measure during th...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~124-~124: To elevate your writing, try using a synonym here.
Context: ... measure delayed outcomes which make it hard to measure during the runtime of an exp...
(HARD_TO)
[uncategorized] ~124-~124: A comma may be missing after the conjunctive/linking adverb ‘Typically’.
Context: ...re during the runtime of an experiment. Typically long-term metrics represent the strateg...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~125-~125: The noun “decision-making” (= the process of deciding something) is spelled with a hyphen.
Context: ...iness outcomes. Using such a metric for decision making requires adapting the experiment design...
(DECISION_MAKING)
[uncategorized] ~125-~125: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e experiment design so it captures this long term impact. Examples: - `true_conversion_...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around lines 124
to 125, the sentence needs three punctuation/hyphenation fixes: add a comma
after "Typically", add a comma after "outcomes", and hyphenate "long term" to
"long-term" when used as a compound adjective; update the sentence accordingly
so it reads with the two commas and the hyphenated compound adjective.
| Finally metrics can also be described by how they operate in the context of the experiment. | ||
|
|
||
| #### Proxy | ||
| **Proxy** metrics are indirect measures used to evaluate an outcome that cannot be measured directly (see for the example of long-term metrics above). In experimentation proxy metrics can be used as a replacement for the actual desired goal. There should be a strong correlation between the proxy and the actual goal and this should be validated frequently. |
There was a problem hiding this comment.
Add missing commas for clarity.
Two commas are needed to properly punctuate this sentence.
-**Proxy** metrics are indirect measures used to evaluate an outcome that cannot be measured directly (see for the example of long-term metrics above). In experimentation proxy metrics can be used as a replacement for the actual desired goal. There should be a strong correlation between the proxy and the actual goal and this should be validated frequently.
+**Proxy** metrics are indirect measures used to evaluate an outcome that cannot be measured directly (see the example of long-term metrics above). In experimentation, proxy metrics can be used as a replacement for the actual desired goal. There should be a strong correlation between the proxy and the actual goal, and this should be validated frequently.🧰 Tools
🪛 LanguageTool
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...example of long-term metrics above). In experimentation proxy metrics can be used as a replacem...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...lation between the proxy and the actual goal and this should be validated frequently...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 137,
the sentence is missing two commas that improve readability; insert a comma
after "(see for the example of long-term metrics above)" to close that
parenthetical and another comma after "In experimentation" so the sentence reads
with proper pauses: "In experimentation, proxy metrics can be used..." and
ensure spacing remains correct.
| If you edit them, the change applies to every version of the metric. | ||
|
|
||
| - `Name`. To ensure consistency and discoverability, the name of a metric needs to be the same across all versions of a metric. | ||
| - `Owner`. To better enforce ownership and governance, metric's owners must own the entire history of a metric including all its past versions. |
There was a problem hiding this comment.
Add missing article and comma.
Two punctuation corrections needed in this sentence.
-`Owner`. To better enforce ownership and governance, metric's owners must own the entire history of a metric including all its past versions.
+`Owner`. To better enforce ownership and governance, the metric's owners must own the entire history of a metric, including all its past versions.📝 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.
| - `Owner`. To better enforce ownership and governance, metric's owners must own the entire history of a metric including all its past versions. | |
| - `Owner`. To better enforce ownership and governance, the metric's owners must own the entire history of a metric, including all its past versions. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~181-~181: Possible missing article found.
Context: ...etter enforce ownership and governance, metric's owners must own the entire history of...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~181-~181: Possible missing comma found.
Context: ...owners must own the entire history of a metric including all its past versions. ### E...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 181,
the sentence is missing an article and a comma; change "metric's owners must own
the entire history of a metric including all its past versions." to use "the
metric's owners" and add a comma after "metric" so it reads "...the entire
history of a metric, including all its past versions."
|
|
||
| ### Ownership | ||
|
|
||
| A goal can owned by 1 or more teams and, if the feature was enable for your organisation, individual users. |
There was a problem hiding this comment.
Fix grammar: verb phrase and past participle agreement.
Line 213 contains two grammatical errors (identical to issues in goals/overview.mdx line 40):
- "can owned" should be "can be owned"
- "was enable" should be "was enabled"
-A goal can owned by 1 or more teams and, if the feature was enable for your organisation, individual users.
+A metric can be owned by 1 or more teams and, if the feature was enabled for your organisation, individual users.Note: The subject should also be "A metric" (not "goal") to match this document's context.
📝 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.
| A goal can owned by 1 or more teams and, if the feature was enable for your organisation, individual users. | |
| A metric can be owned by 1 or more teams and, if the feature was enabled for your organisation, individual users. |
🧰 Tools
🪛 LanguageTool
[grammar] ~213-~213: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~213-~213: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 213,
the sentence has grammatical errors and the wrong subject; change "A goal can
owned by 1 or more teams and, if the feature was enable for your organisation,
individual users." to use the correct subject and verb forms: "A metric can be
owned by one or more teams and, if the feature was enabled for your
organisation, individual users." Ensure "goal" → "metric", "can owned" → "can be
owned", "was enable" → "was enabled", and optionally expand "1" to "one" for
consistency.
| | Permission | Description | | ||
| |-------------------------|----------------------------| | ||
| | **Admin metrics** | Grants full administrative control over metrics, including managing permissions, visibility, and configuration settings for all metrics within the workspace or team. | | ||
| | **Archive a metric** | Allows archiving a metric that is no longer in use, archign a metric archive **all the versions** of that metric. | |
There was a problem hiding this comment.
Fix typo: "archign" → "archiving".
Line 230 contains a spelling error in the permission description table.
-| **Archive a metric** | Allows archiving a metric that is no longer in use, archign a metric archive **all the versions** of that metric. |
+| **Archive a metric** | Allows archiving a metric that is no longer in use, archiving **all the versions** of that metric. |Note: The phrase "archive all the versions" is also awkwardly phrased. Consider: "Allows archiving a metric that is no longer in use, including all of its versions."
📝 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.
| | **Archive a metric** | Allows archiving a metric that is no longer in use, archign a metric archive **all the versions** of that metric. | | |
| | **Archive a metric** | Allows archiving a metric that is no longer in use, archiving **all the versions** of that metric. | |
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/overview.mdx around line 230,
fix the typo "archign" to "archiving" and reword the clause for clarity; replace
the current sentence with something like: "Allows archiving a metric that is no
longer in use, including all of its versions." Ensure punctuation and bold
formatting around "all of its versions" is preserved or adjusted to match
surrounding table style.
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (9)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx (6)
213-213: Fix verb phrase and past participle agreement.Line 213 contains two grammatical errors (note: the subject should be "A metric" not "goal"):
-A metric can owned by 1 or more teams and, if the feature was enable for your organisation, individual users. +A metric can be owned by 1 or more teams and, if the feature was enabled for your organisation, individual users.Note: "can owned" → "can be owned" and "enable" → "enabled".
257-257: Add missing comma after conditional "if" clause.Line 257 needs a comma to separate the conditional clause from the main clause:
-Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams. +Team roles are inherited, so if a user is a `Team Contributor` in a team, then this user would also be a `Team Contributor` in all child teams.
230-230: Fix typo and awkward phrasing.Line 230 contains a spelling error and awkward phrasing:
-| **Archive a metric** | Allows archiving a metric that is no longer in use, archign a metric archive **all the versions** of that metric. | +| **Archive a metric** | Allows archiving a metric that is no longer in use, including all of its versions. |
20-20: Add missing comma after introductory clause.Line 20 needs a comma after the introductory phrase:
-In this page we try to explain the most important attributes and what they mean in the context of experimentation. +In this page, we try to explain the most important attributes and what they mean in the context of experimentation.
146-146: Fix article–noun agreement.Line 146 has mismatched article and noun number. Remove the article "a" before the plural noun:
-`Overall Evaluation Criterion` (OEC) as a weighted combinations of metrics like engagement, revenue, and satisfaction +`Overall Evaluation Criterion` (OEC) as weighted combinations of metrics like engagement, revenue, and satisfaction
61-62: Fix subject-verb agreement and remove stray character.Lines 61–62 have two issues:
- Line 61: Article-noun agreement error with "A metrics"
- Line 62: Stray equals sign at end of line
-A metrics can be described as a **business** metric, a **behavioural** metric or an **operational** metrics. -Those attributes describe the purpose of the metric, what it is measuring.= +Metrics can be described as business, behavioural, or operational metrics. +Those attributes describe the purpose of the metric, what it is measuring.docs/web-console-docs/goals-and-metrics/goals/overview.mdx (2)
40-40: Fix verb phrase and past participle agreement.Line 40 contains two grammatical errors:
-A goal can owned by 1 or more teams and, if the feature was enable for your organisation, individual users. +A goal can be owned by 1 or more teams and, if the feature was enabled for your organisation, individual users.Note: "can owned" → "can be owned" and "enable" → "enabled".
89-89: Add missing comma after conditional "if" clause.Line 89 needs a comma to separate the conditional clause from the main clause:
-Team roles are inherited, so if a user is a `Team Contributor` in a team then this user would also be a `Team Contributor` in all child teams. +Team roles are inherited, so if a user is a `Team Contributor` in a team, then this user would also be a `Team Contributor` in all child teams.docs/web-console-docs/goals-and-metrics/metrics/create.mdx (1)
282-282: Add missing comma after "accurately".Line 282 needs a comma to separate the participial phrase:
-This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change. +This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately, providing a more accurate view on the impact of the change.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/web-console-docs/goals-and-metrics/goals/overview.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/categories.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/ratio.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/metric-types/unique-property-count.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/overview.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/goals-and-metrics/goals/overview.mdx
[typographical] ~13-~13: Consider adding a colon here.
Context: ...at to observe in the experiment. Goals are the raw data used to compute [Metrics](../m...
(MY_QUESTION_IS_COLON)
[grammar] ~40-~40: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~40-~40: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~94-~94: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...h other teams and individual across the organisation. | Permission | Description | |-------...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/unique-property-count.mdx
[uncategorized] ~34-~34: Possible missing comma found.
Context: ... count. - Outlier settings do not apply here since the metric counts distinct string...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~282-~282: Possible missing comma found.
Context: ...revenue reflect the impact of refunds accurately providing a more accurate view on the i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~338-~338: Would you like to use the Oxford spelling “customize”? The spelling ‘customise’ is also correct.
Context: ...maxWidth="50rem" centered /> You can customise three aspects for both Value and **...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~430-~430: Possible missing comma found.
Context: ...ul. In this case and to prevent further loss it might be worth stopping the experime...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/overview.mdx
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...er visitor, or click-through rate`. Metrics can represent direct business outcomes,...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~20-~20: It appears that a comma is missing.
Context: ...ning those attributes together. In this page we try to explain the most important at...
(DURING_THAT_TIME_COMMA)
[style] ~27-~27: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...change achieves its desired outcome and whether or not the hypothesis is validated or rejected...
(WHETHER)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...context and insights beyond the primary metric and can help detect unintended side eff...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ...te-calls_to_customer_support` #### Behavioural Behavioural metrics are metrics measuring the imp...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~74-~74: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ange and as such have high sensitivity. Behavioural metrics are often used as secondary met...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[duplication] ~81-~81: Possible typo: you repeated a word.
Context: ...on_banner-product_page_views` #### Operational Operational metrics, also known as technical metr...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~82-~82: Possible missing comma found.
Context: ...metrics can be used as guardrail metrics but also possibly as primary or secondary m...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~92-~92: Possible typo: you repeated a word.
Context: ... data is structured and measured. #### Binomial Binomial metrics represent a binary outcome fo...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ... churn_rate - email_open_rate #### Continuous Continuous metrics on the other hand can take on...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~103-~103: Consider separating this adverbial phrase with commas.
Context: ... #### Continuous Continuous metrics on the other hand can take on a wide range of values (eit...
(ON_THE_OTHER_HAND_COMMA)
[uncategorized] ~103-~103: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r range of data) and offer more insights but they can be heavily influenced by outli...
(COMMA_COMPOUND_SENTENCE)
[duplication] ~114-~114: Possible typo: you repeated a word.
Context: ... short-term or long-term. #### Short-term Short-term metrics refer to metrics that measure...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~124-~124: Possible missing comma found.
Context: ..., long-term metrics measure delayed outcomes which make it hard to measure during th...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~124-~124: To elevate your writing, try using a synonym here.
Context: ... measure delayed outcomes which make it hard to measure during the runtime of an exp...
(HARD_TO)
[uncategorized] ~124-~124: A comma may be missing after the conjunctive/linking adverb ‘Typically’.
Context: ...re during the runtime of an experiment. Typically long-term metrics represent the strateg...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~125-~125: The noun “decision-making” (= the process of deciding something) is spelled with a hyphen.
Context: ...iness outcomes. Using such a metric for decision making requires adapting the experiment design...
(DECISION_MAKING)
[uncategorized] ~125-~125: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e experiment design so it captures this long term impact. Examples: - `true_conversion_...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[duplication] ~136-~136: Possible typo: you repeated a word.
Context: ...n the context of the experiment. #### Proxy Proxy metrics are indirect measures used to...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...example of long-term metrics above). In experimentation proxy metrics can be used as a replacem...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...lation between the proxy and the actual goal and this should be validated frequently...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~143-~143: Possible typo: you repeated a word.
Context: ...button` as a proxy for conversion #### Composite Composite metrics combine multiple individual m...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~146-~146: The plural noun “combinations” cannot be used with the article “a”. Did you mean “a weighted combination” or “weighted combinations”?
Context: ...Overall Evaluation Criterion (OEC) as a weighted combinations of metrics like engagement, revenue, an...
(A_NNS)
[style] ~160-~160: ‘refer back’ might be wordy. Consider a shorter alternative.
Context: ...arent and reproducible: You can always refer back to earlier versions and understand exac...
(EN_WORDINESS_PREMIUM_REFER_BACK)
[style] ~160-~160: This phrase is redundant. Consider writing “point” or “time”.
Context: ...tly how a metric was constructed at any point in time. - Teams can evolve metrics safely: Yo...
(MOMENT_IN_TIME)
[uncategorized] ~181-~181: Possible missing article found.
Context: ...etter enforce ownership and governance, metric's owners must own the entire history of...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~181-~181: Possible missing comma found.
Context: ...owners must own the entire history of a metric including all its past versions. ### E...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~213-~213: Consider using either the past participle “enabled” or the present participle “enabling” here.
Context: ...1 or more teams and, if the feature was enable for your organisation, individual users...
(BEEN_PART_AGREEMENT)
[style] ~213-~213: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...and, if the feature was enable for your organisation, individual users. :::info Team owners...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~257-~257: Possible missing comma found.
Context: ... if a user is a Team Contributor in a team then this user would also be a `Team Co...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~262-~262: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...h other teams and individual across the organisation. | Permission | Description | |-------...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/goals-and-metrics/metrics/categories.mdx
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...engagement, retention, revenue`, etc but feel free to create and manage categori...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~14-~14: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ement, retention, revenue`, etc but feel free to create and manage categories that best ...
(FEEL_FREE_TO_STYLE_ME)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/ratio.mdx
[formatting] ~12-~12: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...onversion, quality, or per-user averages, because they remove scale effects and highlight...
(COMMA_BEFORE_BECAUSE)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx
[uncategorized] ~40-~40: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...y: - they completed the initial purchase - and they completed another purchase after 7...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...ples** - Checkout Recovery (24 hours): Users who returned to complete a purcha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...ng to cart. - Content Return (3 days): Users who read an article again within ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...ing. - Subscription Renewal (30 days): Users who returned to perform a renewal...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~61-~61: The modal verb ‘will’ requires the verb’s base form.
Context: ...ters the meaning of the metric and will requires a new version. - Useful for experiments...
(MD_BASEFORM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Yarn Build
🔇 Additional comments (1)
docs/web-console-docs/goals-and-metrics/metrics/metric-types/unique-property-count.mdx (1)
1-35: Documentation reads well; no issues identified.The content is clear, well-organised, and grammatically sound. The examples effectively illustrate the concept, and the "Good to know" section provides helpful context.
|
|
||
| Use a category to describe what a metric is about, it can represent direct business outcomes, engagement signals, or technical performance indicators. | ||
|
|
||
| Frequently used categories include `conversion`, `engagement`, `retention`, `revenue`, etc but feel free to create and manage categories that best suit your needs. |
There was a problem hiding this comment.
Add comma before "but" in compound sentence.
Line 14 needs a comma before the coordinating conjunction "but":
-Frequently used categories include `conversion`, `engagement`, `retention`, `revenue`, etc but feel free to create and manage categories that best suit your needs.
+Frequently used categories include `conversion`, `engagement`, `retention`, `revenue`, etc, but feel free to create and manage categories that best suit your needs.🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...engagement, retention, revenue`, etc but feel free to create and manage categori...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~14-~14: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ement, retention, revenue`, etc but feel free to create and manage categories that best ...
(FEEL_FREE_TO_STYLE_ME)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/categories.mdx around line
14, the sentence "Frequently used categories include `conversion`, `engagement`,
`retention`, `revenue`, etc but feel free to create and manage categories that
best suit your needs." is missing a comma before the coordinating conjunction
"but"; insert a comma after "etc" (or before "but") so it reads "...`revenue`,
etc, but feel free..." to correct the compound sentence punctuation.
| A Ratio metric compares two related metrics by dividing one value (the numerator) by another (the denominator). | ||
| This creates a normalized measure that reveals the relationship between the two quantities rather than their absolute values. | ||
|
|
||
| Ratio metrics are useful when you want to understand efficiency, conversion, quality, or per-user averages, because they remove scale effects and highlight how one metric behaves relative to another. |
There was a problem hiding this comment.
Remove comma before "because" clause.
Line 12 has an unnecessary comma before the essential "because" clause. Since the clause is integral to the meaning, the comma should be removed:
-Ratio metrics are useful when you want to understand efficiency, conversion, quality, or per-user averages, because they remove scale effects and highlight how one metric behaves relative to another.
+Ratio metrics are useful when you want to understand efficiency, conversion, quality, or per-user averages because they remove scale effects and highlight how one metric behaves relative to another.📝 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.
| Ratio metrics are useful when you want to understand efficiency, conversion, quality, or per-user averages, because they remove scale effects and highlight how one metric behaves relative to another. | |
| Ratio metrics are useful when you want to understand efficiency, conversion, quality, or per-user averages because they remove scale effects and highlight how one metric behaves relative to another. |
🧰 Tools
🪛 LanguageTool
[formatting] ~12-~12: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...onversion, quality, or per-user averages, because they remove scale effects and highlight...
(COMMA_BEFORE_BECAUSE)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/metric-types/ratio.mdx around
line 12, there is an unnecessary comma before the essential "because" clause;
remove the comma after "averages" so the sentence reads without the pause (i.e.,
delete the comma before "because") to keep the clause integral to the meaning.
| - they completed the initial purchase | ||
| - and they completed another purchase after 7 days, within the configured retention window |
There was a problem hiding this comment.
Add comma before "and" in compound sentence.
Line 40 needs a comma to properly separate the independent clauses:
-they completed the initial purchase
-and they completed another purchase after 7 days, within the configured retention window
+they completed the initial purchase,
+and they completed another purchase after 7 days, within the configured retention windowCommittable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...y: - they completed the initial purchase - and they completed another purchase after 7...
(COMMA_COMPOUND_SENTENCE)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx
around lines 40-41, the two bullet lines form a compound sentence and need a
comma after the first clause; add a comma at the end of line 40 ("- they
completed the initial purchase,") so the sentence correctly reads with a comma
before "and they completed another purchase after 7 days, within the configured
retention window."
| - The metric counts users, not events — a user either meets retention criteria or does not. | ||
| - Filters on the goal event apply before evaluating retention (for example: “retention among users who purchased category ZYZ123”). | ||
| - Retention metrics are often more stable and less noisy than total repeated activations, since each user contributes at most once. | ||
| - Changing the retention period alters the meaning of the metric and will requires a new version. |
There was a problem hiding this comment.
Fix verb agreement: "will requires" → "will require".
Line 61 contains a grammatical error with the verb form. The modal verb "will" requires the base form:
-Changing the retention period alters the meaning of the metric and will requires a new version.
+Changing the retention period alters the meaning of the metric and will require a new version.📝 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.
| - Changing the retention period alters the meaning of the metric and will requires a new version. | |
| - Changing the retention period alters the meaning of the metric and will require a new version. |
🧰 Tools
🪛 LanguageTool
[grammar] ~61-~61: The modal verb ‘will’ requires the verb’s base form.
Context: ...ters the meaning of the metric and will requires a new version. - Useful for experiments...
(MD_BASEFORM)
🤖 Prompt for AI Agents
In docs/web-console-docs/goals-and-metrics/metrics/metric-types/retention.mdx
around line 61, fix the verb agreement in the sentence by replacing "will
requires" with the correct base-form "will require" so the modal verb "will" is
followed by the proper verb form.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/web-console-docs/experiments/templates.mdx (1)
73-73: Fix spelling error in line 73.There is a typo: "experimemts" should be "experiments".
-The field is no longer editable and all children experimemts will have a pre-set 90% confidence level. +The field is no longer editable and all children experiments will have a pre-set 90% confidence level.
♻️ Duplicate comments (3)
docs/web-console-docs/goals-and-metrics/metrics/categories.mdx (1)
14-14: Add comma before coordinating conjunction "but" in compound sentence.The sentence contains two independent clauses joined by "but" and requires a comma before the conjunction.
-Frequently used categories include `conversion`, `engagement`, `retention`, `revenue`, etc but feel free to create and manage categories that best suit your needs. +Frequently used categories include `conversion`, `engagement`, `retention`, `revenue`, etc, but feel free to create and manage categories that best suit your needs.docs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
282-282: Add comma after "accurately" to separate the participial phrase.The participial phrase "providing a more accurate view" requires a comma to separate it from the preceding clause.
-This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately providing a more accurate view on the impact of the change. +This relation ensures that metrics involving values such as `revenue` reflect the impact of refunds accurately, providing a more accurate view on the impact of the change.
430-430: Add commas for proper compound sentence punctuation.The sentence contains a parenthetical phrase that requires commas on both sides or a restructure for clarity.
-In this case and to prevent further loss it might be worth stopping the experiment and investigating what is happening. +In this case, and to prevent further loss, it might be worth stopping the experiment and investigating what is happening.
🧹 Nitpick comments (4)
docs/web-console-docs/experiments/Aborting-experiments.mdx (1)
50-50: Missing comma in sentence.The sentence "In a fixed-horizon experiment, results should ideally be evaluated only at the pre-determined horizon (e.g., after collecting the required sample size). Aborting a fixed-horizon experiment means making a decisions (usually to stop) before the experiment has collected the required sample size. Aborting is not recommended because fixed-horizon tests require full sample size completion to ensure validity." — specifically the transition around line 15 (not shown in snippet but flagged by static analysis) should include a comma: "Group Sequential and Fixed Horizon experiment**,** check our [analysis type article]...".
Additionally, note that the relative link to
[experiment-health-checks]at line 50 should be verified to ensure it resolves to the correct target file.docs/web-console-docs/experiments/setting-up-a-gst-experiment.mdx (1)
15-15: Missing comma in sentence and verify relative link.Line 15: "To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article]..." is missing a comma before "check". Should read: "...Horizon experiment**,** check our...".
Additionally, verify that the relative link
(types-of-analysis)resolves correctly to the target file.docs/web-console-docs/experiments/setting-up-a-fixed-horizon-experiment.mdx (1)
14-14: Missing comma in sentence.Line 14: "To understand the differences between Group Sequential and Fixed Horizon experiment check our [analysis type article]..." requires a comma before "check". Should read: "...Horizon experiment**,** check our...".
Verify that the relative link
(types-of-analysis)resolves correctly to the target file.docs/web-console-docs/experiments/creating-an-experiment.mdx (1)
225-225: Missing commas in multiple sentences.Static analysis flagged missing commas at lines ~225, ~227, ~238, and ~253. These appear to be coordination conjunction errors where commas are needed:
- Line 225: "To choose between a Group Sequential or Fixed Horizon analysis check our [analysis type article]..." → should be "...analysis**,** check our..."
- Line 227: "To continue to properly set up your experiment refer to the relevant setup guide..." → may need comma after "guide"
- Line 238: "...and add tags to help with searching and filtering later on..." → should verify comma placement
- Line 253: "...define for yourself and your team why you are running this experiment..." → should verify comma placement
Review these sentences for proper comma usage.
Also applies to: 227-227, 238-238, 253-253
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
docs/web-console-docs/experiments/Aborting-experiments.mdx(2 hunks)docs/web-console-docs/experiments/Experiment-health-checks.mdx(2 hunks)docs/web-console-docs/experiments/Experiment-reports.mdx(3 hunks)docs/web-console-docs/experiments/Interpreting-metrics-in-experiment-results.mdx(1 hunks)docs/web-console-docs/experiments/creating-an-experiment.mdx(6 hunks)docs/web-console-docs/experiments/setting-up-a-fixed-horizon-experiment.mdx(2 hunks)docs/web-console-docs/experiments/setting-up-a-gst-experiment.mdx(2 hunks)docs/web-console-docs/experiments/templates.mdx(1 hunks)docs/web-console-docs/experiments/types-of-analysis.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/goals/create.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/categories.mdx(1 hunks)docs/web-console-docs/goals-and-metrics/metrics/create.mdx(1 hunks)docs/web-console-docs/tutorial.mdx(3 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/web-console-docs/experiments/Interpreting-metrics-in-experiment-results.mdx
- docs/web-console-docs/experiments/types-of-analysis.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/web-console-docs/tutorial.mdx
🧰 Additional context used
🪛 LanguageTool
docs/web-console-docs/experiments/Experiment-reports.mdx
[grammar] ~143-~143: The auxiliary verb ‘do’ requires the base form of the verb.
Context: ... evidence validation does not currently includes checks on the secondary and guardrail m...
(DID_BASEFORM)
docs/web-console-docs/experiments/setting-up-a-fixed-horizon-experiment.mdx
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...ween Group Sequential and Fixed Horizon experiment check our [analysis type article](types...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/experiments/creating-an-experiment.mdx
[uncategorized] ~225-~225: Possible missing comma found.
Context: ...een a Group Sequential or Fixed Horizon analysis check our [analysis type article](types...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~227-~227: Possible missing comma found.
Context: ...). To continue to properly set up your experiment refer to the relevant setup guide - [*...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...s experiment, assign it to a particular team and add tags to help with searching and...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...riment, what you hope for the result to be and what will be done after any of the ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/experiments/setting-up-a-gst-experiment.mdx
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...ween Group Sequential and Fixed Horizon experiment check our [analysis type article](types...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/goals-and-metrics/metrics/categories.mdx
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...engagement, retention, revenue`, etc but feel free to create and manage categori...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~14-~14: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ement, retention, revenue`, etc but feel free to create and manage categories that best ...
(FEEL_FREE_TO_STYLE_ME)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx
[uncategorized] ~282-~282: Possible missing comma found.
Context: ...revenue reflect the impact of refunds accurately providing a more accurate view on the i...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~338-~338: Would you like to use the Oxford spelling “customize”? The spelling ‘customise’ is also correct.
Context: ...maxWidth="50rem" centered /> You can customise three aspects for both Value and **...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~430-~430: Possible missing comma found.
Context: ...ul. In this case and to prevent further loss it might be worth stopping the experime...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (15)
docs/web-console-docs/goals-and-metrics/goals/create.mdx (1)
1-42: Documentation is well-structured and grammatically sound.All previously flagged issues have been addressed. The file presents clear, logical guidance on creating goals with proper formatting, helpful callouts, and correct grammar throughout.
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (1)
338-338: British vs. American spelling: "customise" is correct for en-GB.The static analysis tool flagged "customise" as a style preference suggesting "customize". Both spellings are correct—"customise" aligns with British English (en-GB), whilst "customize" is American English. Since the review should follow en-GB standards (as indicated by the language requirement), the current spelling is appropriate and requires no change.
docs/web-console-docs/experiments/templates.mdx (2)
7-7: Page title and section header changes improve clarity.The page title has been updated from "Creating and Using Templates" to "Experiment Templates", and the section header from "Introduction" to "Overview". These changes improve semantic clarity and alignment with documentation conventions.
Also applies to: 9-9
5-5: Import path is correct and properly resolves to the Image component.Verification confirms that the relative import path
../../../src/components/Imagecorrectly resolves fromdocs/web-console-docs/experiments/templates.mdxto the Image component insrc/components/Image/. The component is properly exported viaindex.ts, and the path depth is appropriate for the file's nested location.docs/web-console-docs/experiments/Aborting-experiments.mdx (1)
5-5: Image import path update aligns with restructured documentation hierarchy.The change from
../../src/components/Imageto../../../src/components/Imageis consistent with the broader PR pattern and reflects deeper nesting of the file within the directory structure.docs/web-console-docs/experiments/setting-up-a-gst-experiment.mdx (1)
5-6: Import paths correctly updated to reflect deeper nesting.Both the Image and FutureDate component imports have been updated to use the deeper relative path
../../../src/components/, which aligns with the documented file restructuring.docs/web-console-docs/experiments/setting-up-a-fixed-horizon-experiment.mdx (1)
5-5: Import path update is correct.The Image import path has been properly updated to
../../../src/components/Image, consistent with the PR's documentation restructuring.docs/web-console-docs/experiments/Experiment-reports.mdx (2)
5-5: Image import path correctly updated.
82-83: Verify consistency of link formats across file.Lines 82–83 still use absolute link paths
/docs/web-console-docs/types-of-analysis, but line 105 uses a relative link(Aborting-experiments). Similarly, line 163 uses an absolute path/docs/web-console-docs/Aborting-experimentswhile line 105 in the same section uses a relative link. Ensure all internal links follow a consistent format (either all relative or all absolute) as per the PR restructuring pattern.docs/web-console-docs/experiments/Experiment-health-checks.mdx (3)
5-5: Image import path update is correct.
12-14: Text reflow is acceptable.The paragraph restructuring at lines 12–14 maintains the original meaning whilst improving readability; no content changes are introduced.
64-64: Verify consistency of internal link paths.Line 64 uses an absolute path
/docs/web-console-docs/experiments/creating-an-experiment#targeting-audience. Verify whether this should be converted to a relative link format (e.g.,creating-an-experiment#targeting-audience) to align with the PR's general pattern of shifting to relative links, as seen in other files within this PR.docs/web-console-docs/experiments/creating-an-experiment.mdx (3)
5-5: Image import path correctly updated.
16-16: Verify relative link target exists.Line 16 uses a relative link to
(templates). Verify that atemplates.mdxfile exists in the experiments directory or appropriate parent directory.
122-122: Verify new goals-and-metrics path structure.Line 122 links to
/docs/web-console-docs/goals-and-metrics/metrics/overview. This represents a new directory structure. Verify that:
- The
goals-and-metricsdirectory exists- The
metricssubdirectory exists within it- The
overview.mdxfile exists at that path
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (7)
docs/platform-release-notes/2025/04.mdx (1)
23-23: Remove trailing asterisk from bold markup.The sentence should end cleanly without the extra asterisk.
-- **Secondary & Guardrail metrics:** Like with the primary metric, you can now see the experiment results on the secondary and guardrail metrics. This helps understand the rationale behind each decision.** +- **Secondary & Guardrail metrics:** Like with the primary metric, you can now see the experiment results on the secondary and guardrail metrics. This helps understand the rationale behind each decision.docs/web-console-docs/experiments/Experiment-reports.mdx (1)
143-143: Fix verb form mismatch in conditional clause.The auxiliary verb "does" requires the base form "include", not "includes".
Apply this diff:
-The supported by evidence validation does not currently includes checks on the secondary and guardrail metrics nor on the experiment [health checks](experiment-health-checks). +The supported by evidence validation does not currently include checks on the secondary and guardrail metrics nor on the experiment [health checks](experiment-health-checks).docs/web-console-docs/experiments/creating-an-experiment.mdx (1)
96-96: Case sensitivity mismatch:configurationshould beConfiguration.The previous review flagged this critical issue which persists in this commit. Lines 96, 101, 238, and 253 contain links with lowercase
configuration, but the filesystem directory isConfiguration(capital C). On case-sensitive systems, these links will fail.Update all four instances:
- Line 96:
/docs/web-console-docs/configuration/settings#units→/docs/web-console-docs/Configuration/settings#units- Line 101:
/docs/web-console-docs/configuration/settings#applications→/docs/web-console-docs/Configuration/settings#applications- Line 238:
/docs/web-console-docs/configuration/settings#platform-settings→/docs/web-console-docs/Configuration/settings#platform-settings- Line 253:
/docs/web-console-docs/configuration/settings#platform-settings→/docs/web-console-docs/Configuration/settings#platform-settingsAlso applies to: 101-101, 238-238, 253-253
docs/web-console-docs/Configuration/Units.mdx (4)
10-10: Fix grammar: missing preposition "to".Line 10 is missing the preposition "to". The sentence should read "Units are also referred to as tracking identifiers", not "referred as".
Apply this diff:
-Units are also referred as tracking identifiers. +Units are also referred to as tracking identifiers.
19-20: Fix collocation: "in the website" should be "on the website".Lines 19–20 use the incorrect collocation "in the website". The correct preposition in technology contexts is "on".
Apply this diff:
-but if you are interested in collecting metrics tracked in the website that the newsletter is linking to, -it's better to use the same unit that is being used for the experiments running in the website. +but if you are interested in collecting metrics tracked on the website that the newsletter is linking to, +it's better to use the same unit that is being used for the experiments running on the website.
34-34: Add missing comma before parenthetical phrase.Line 34 requires a comma after "several
anonymous_id" before the parenthetical remark.Apply this diff:
-Others like `anonymous_id` are much more transient. This means that the same physical user could potentially have several `anonymous_id` (and as a result see a different variant of your experiment). +Others like `anonymous_id` are much more transient. This means that the same physical user could potentially have several `anonymous_id`, (and as a result see a different variant of your experiment).
36-36: Fix typo: "likey" should be "likely".Line 36 contains a spelling error.
Apply this diff:
-While an `anonymous_id` identifier is likey always available, the `user_id` might only be available in parts of the applications where the visitor is logged in. +While an `anonymous_id` identifier is likely always available, the `user_id` might only be available in parts of the applications where the visitor is logged in.
🧹 Nitpick comments (1)
docs/platform-release-notes/2024/12.mdx (1)
29-30: Améliorer la lisibilité avec une virgule après « templates ».Ajouter une virgule améliorerait la clarté de la phrase.
Appliquer ce diff :
-our [documentation](/docs/web-console-docs/experiments/templates). +our [documentation](/docs/web-console-docs/experiments/templates).Actually, I apologize - I need to reconsider. Looking more carefully:
-For more information on creating and using templates you can read our +For more information on creating and using templates, you can read our
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
docs/platform-release-notes/2024/12.mdx(2 hunks)docs/platform-release-notes/2025/02.mdx(1 hunks)docs/platform-release-notes/2025/03.mdx(1 hunks)docs/platform-release-notes/2025/04.mdx(1 hunks)docs/web-console-docs/Configuration/Units.mdx(1 hunks)docs/web-console-docs/experiments/Experiment-health-checks.mdx(3 hunks)docs/web-console-docs/experiments/Experiment-reports.mdx(5 hunks)docs/web-console-docs/experiments/creating-an-experiment.mdx(7 hunks)docs/web-console-docs/tutorial.mdx(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/web-console-docs/experiments/Experiment-health-checks.mdx
- docs/web-console-docs/tutorial.mdx
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2024/12.mdx
[uncategorized] ~29-~29: Possible missing comma found.
Context: ... more information on creating and using templates you can read our [documentation](/docs/...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/platform-release-notes/2025/04.mdx
[typographical] ~21-~21: It appears that a comma is missing.
Context: ...t-reports/#decisions-overview). In this release we are introducing a few improvements t...
(DURING_THAT_TIME_COMMA)
docs/web-console-docs/experiments/creating-an-experiment.mdx
[uncategorized] ~197-~197: Possible missing comma found.
Context: ... on early stopping of experiments using ABsmartly you can read our [**early stopping guid...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~225-~225: Possible missing comma found.
Context: ...een a Group Sequential or Fixed Horizon analysis check our [analysis type article](types...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~227-~227: Possible missing comma found.
Context: ...). To continue to properly set up your experiment refer to the relevant setup guide - [*...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...s experiment, assign it to a particular team and add tags to help with searching and...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...riment, what you hope for the result to be and what will be done after any of the ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/Configuration/Units.mdx
[uncategorized] ~10-~10: Possible missing preposition found.
Context: ...applications). Units are also referred as tracking identifiers. For experiments ...
(AI_HYDRA_LEO_MISSING_TO)
[grammar] ~19-~19: The usual collocation for technology is “on”, not “in”.
Context: ...nterested in collecting metrics tracked in the website that the newsletter is linking to, it'...
(IN_THE_INTERNET)
[grammar] ~20-~20: The usual collocation for technology is “on”, not “in”.
Context: ... being used for the experiments running in the website. Have a look at the [Tracking Unit](/d...
(IN_THE_INTERNET)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...y have several anonymous_id (and as a result see a different variant of your experim...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/web-console-docs/experiments/Experiment-reports.mdx
[grammar] ~143-~143: The auxiliary verb ‘do’ requires the base form of the verb.
Context: ... evidence validation does not currently includes checks on the secondary and guardrail m...
(DID_BASEFORM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - absmartly-docs
- GitHub Check: Header rules - absmartly-docs
- GitHub Check: Pages changed - absmartly-docs
- GitHub Check: Yarn Build
🔇 Additional comments (11)
docs/platform-release-notes/2024/12.mdx (1)
22-22: ✓ Documentation links updated correctly for new structure.The paths have been consistently updated to reflect the new experiments-focused documentation hierarchy (
/docs/web-console-docs/experiments/*), which aligns with the PR's reorganisation objectives.Also applies to: 30-30, 39-39
docs/platform-release-notes/2025/03.mdx (1)
33-33: Link path correctly updated to reflect restructured documentation hierarchy.The path now properly routes to the experiments subfolder. This aligns with the reorganisation mentioned in the AI summary.
docs/platform-release-notes/2025/04.mdx (1)
24-24: Health checks link correctly updated to new path structure.The relative path now includes the experiments subfolder, maintaining consistency with the documentation reorganisation.
docs/web-console-docs/experiments/Experiment-reports.mdx (3)
5-5: Import path correctly adjusted for new file location.The additional
../accounts for the deeper nesting within the experiments subfolder.
82-83: Relative anchor links correctly applied for cross-document references.The links now use the relative anchor syntax, which aligns with the updated linking conventions mentioned in the AI summary.
105-105: Relative anchor links consistently applied for aborting experiments reference.Both occurrences now use the relative anchor syntax
(Aborting-experiments), maintaining consistency with the updated documentation linking conventions.Also applies to: 163-163
docs/platform-release-notes/2025/02.mdx (1)
13-13: Link path correctly updated to include experiments subfolder.The path now properly routes to the experiments subdirectory, consistent with the documentation restructuring.
docs/web-console-docs/experiments/creating-an-experiment.mdx (3)
5-5: Import path update is appropriate for file nesting level.The import path has been updated from
../../src/components/Imageto../../../src/components/Imageto reflect the increased nesting depth after the file was moved into theexperiments/subdirectory. This change is correct.
16-16: Conversion to relative links improves maintainability.The file successfully converts several absolute links to relative paths, making the documentation more portable and resilient to structural changes. Examples include:
- Line 16:
[template documentation](templates)- Line 197:
(aborting-experiments)- Line 225:
(types-of-analysis)- Lines 229–230:
(setting-up-a-gst-experiment)and(setting-up-a-fixed-horizon-experiment)Also applies to: 197-197, 225-225, 229-230
122-122: The new metrics documentation path is valid and correctly referenced.Verification confirms:
- The file exists at
./docs/web-console-docs/goals-and-metrics/metrics/overview.mdx- The content contains a section titled "## Understanding Experimentation Metrics" that directly aligns with the reference text used in line 122
No issues identified.
docs/web-console-docs/Configuration/Units.mdx (1)
5-5: Import and image asset paths are correctly configured.The import path for the Image component (
../../../src/components/Image) correctly accounts for the three-level nesting within Configuration/Units.mdx. The image reference at lines 25–30 uses a relative path (configuration/units.png), which is appropriate for the modular structure.Also applies to: 25-30
| ## Decisions Report | ||
|
|
||
| Earlier this month we launched the new [Decisions Reports (Beta)](/docs/web-console-docs/experiment-reports/#decisions-overview). In this release we are introducing a few improvements to provide better insights into each decision. | ||
| Earlier this month we launched the new [Decisions Reports (Beta)](/docs/web-console-docs/experiments/experiment-reports/#decisions-overview). In this release we are introducing a few improvements to provide better insights into each decision. |
There was a problem hiding this comment.
Add missing comma after inline link.
The sentence reads more clearly with a comma separating the linked reference from the following clause.
Apply this diff:
-Earlier this month we launched the new [Decisions Reports (Beta)](/docs/web-console-docs/experiments/experiment-reports/#decisions-overview). In this release we are introducing a few improvements to provide better insights into each decision.
+Earlier this month we launched the new [Decisions Reports (Beta)](/docs/web-console-docs/experiments/experiment-reports/#decisions-overview). In this release, we are introducing a few improvements to provide better insights into each decision.(Static analysis: DURING_THAT_TIME_COMMA)
📝 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.
| Earlier this month we launched the new [Decisions Reports (Beta)](/docs/web-console-docs/experiments/experiment-reports/#decisions-overview). In this release we are introducing a few improvements to provide better insights into each decision. | |
| Earlier this month we launched the new [Decisions Reports (Beta)](/docs/web-console-docs/experiments/experiment-reports/#decisions-overview). In this release, we are introducing a few improvements to provide better insights into each decision. |
🧰 Tools
🪛 LanguageTool
[typographical] ~21-~21: It appears that a comma is missing.
Context: ...t-reports/#decisions-overview). In this release we are introducing a few improvements t...
(DURING_THAT_TIME_COMMA)
🤖 Prompt for AI Agents
In docs/platform-release-notes/2025/04.mdx around line 21, the sentence after
the inline link is missing a comma; insert a comma immediately after the closing
bracket of the link so it reads "...Decisions Reports (Beta), in this
release..." to separate the link from the following clause.
Implements server-side (Netlify) and client-side redirects to handle URL structure changes in new-kb branch. Server redirects handle path changes, client script handles anchor/hash updates.
- Add trailing slashes to server redirects to match Docusaurus URL normalization - Strip trailing slash from pathname in client-side redirect check - Add missing anchor redirects for creating-a-feature (application, targeting-audiences)
Add debug logging to understand why client-side anchor redirects aren't working
- Add anchor redirects for OLD page paths (pre-server redirect) - Keep anchor redirects for NEW page paths (post-server redirect) - Remove debug console logging - Verified all redirects work locally with test-anchor-redirects-local.js
- Fix duplicate horizontal rules in release notes - Remove empty lines and fix formatting - Improve JavaScript code blocks (const, camelCase, strict equality) - Fix JSON code block language tags (ts -> json) - Fix content wording (British -> American English, list formatting) - Convert anchorRedirects.js to TypeScript with proper types - Improve index.tsx to use Docusaurus Redirect component - Remove empty 'Special attributes' section - Generate API documentation for build success - Update .gitignore for Claude files and openapi backup All 23 review comments addressed. Build passes successfully. Fixes: #243
- Fix GST redirect: setting-up-a-fixed-horizon-experiment → setting-up-a-gst-experiment - Remove unnecessary anchor redirects that browser preserves automatically (7 removed) - Only keep anchor redirects for actual transformations (9 remaining) Browser automatically preserves unchanged anchors during 302 redirects per HTTP spec. Ref: PR feedback about redirect verification
- Add all 7 server-side redirects from static/_redirects - Add all 9 JS anchor transforms from anchorRedirects.ts - Add 8 browser anchor preservation tests - Add 4 new-path JS transform tests - Fix GST redirect path (corrected in 666c96c) - Group results by redirect type for better reporting - Add comprehensive troubleshooting guidance Total: 28 comprehensive redirect tests covering all documented URL changes.
- Test all ~201 documentation pages load successfully - Test all 23 redirects (server, browser-preserved, JS transforms) - Visual progress indicator and grouped reporting - Comprehensive summary with troubleshooting tips Usage: node test-all-urls.js https://deploy-preview-243--absmartly-docs.netlify.app
Prevents committing backup files with secrets in examples/storage_configs.yaml
- Add 18 missing redirects to static/_redirects (now 25 total, was 7) - SDK Documentation: 10 redirects - Examples: 1 redirect - Configuration: 1 redirect - Users/Teams/Permissions: 2 redirects - Experiments: 8 redirects (including corrected GST redirect) - Feature Flags: 1 redirect - Update test script to test all 48 redirect scenarios - Test script now covers ~136 total URLs (88 pages + 48 redirects) Ensures all renamed pages have proper redirects configured.
- Add --only-failed flag to retry only previously failed pages - Avoids rate limiting by not retesting all pages - Stores list of 37 previously failed pages from first run - Updated help text with flag documentation Usage: node test-all-urls.js <URL> --only-failed
- Fix 'Non engineers' → 'Non-engineers' (add hyphen and 'can') - Remove unnecessary '(for SPAs like Docusaurus)' comment All 25 review comments now addressed.
- Add 200ms throttling between requests to avoid rate limiting - Show each redirect being tested with from → to - Show failed pages immediately with error details - Better progress visibility during test runs Prevents rate limiting on production and provides better debugging output.
- Reduce throttle from 200ms to 50ms (20 req/sec) - Show each redirect being tested (from → to) - Show failed pages immediately with error details - Better visibility during test execution Makes debugging easier and runs faster while avoiding rate limits.
…cts followed - Add response status code to redirect test results - Change waitUntil to 'domcontentloaded' for faster testing - Already case-insensitive via normalizeUrl() lowercasing - Ensure all server redirects are followed before checking final URL
- Show each redirect on single line with checkmark at start - Hide '❌ Broken: 0' when there are zero failures - Cleaner output: only show failure counts when they exist - Better readability and less noise in successful test runs
Added new documentation for events
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.