Launch pad documentation #236
Conversation
chris-absmartly
requested review from
bmsilva,
calthejuggler,
marcio-absmartly and
mario-silva
as code owners
WalkthroughAdds new documentation pages and a docs category configuration. New files:
No runtime code or behavioural changes; documentation and site configuration only. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 0
🧹 Nitpick comments (6)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (6)
21-21: Add missing comma after introductory clause.Line 21 reads: "Unless you have a good reason keep it at 100%." A comma should separate the introductory conditional phrase from the main clause.
-| **Traffic Percentage** | The proportion of total eligible traffic that will be included in the experiment. | Unless you have a good reason keep it at 100%. | +| **Traffic Percentage** | The proportion of total eligible traffic that will be included in the experiment. | Unless you have a good reason, keep it at 100%. |
23-23: Fix grammar: "can runs" should be "can run".Modal verb "can" requires the base form of the verb.
-| **Applications** | The applications where this experiment will run. | The same experiment can runs across multiple apps or sites. | +| **Applications** | The applications where this experiment will run. | The same experiment can run across multiple apps or sites. |
33-33: Fix typo and improve grammar.Line 33 contains a typo ("treament" → "treatment") and awkward phrasing. The sentence should use passive past tense and add a comma after the introductory phrase.
-Each experiment requires at least a control variant and one or more treatment variants. By default experiments are creating with 1 treament variant. +Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant.
38-38: Add comma after introductory phrase.Line 38 requires a comma after "To change this" to separate the introductory phrase from the main clause.
-> **Note:** When using the LaunchPad, traffic is always split equally between all the variants. To change this you can open the experiment on the web console and change the traffic split. +> **Note:** When using the LaunchPad, traffic is always split equally between all the variants. To change this, you can open the experiment on the web console and change the traffic split.
71-74: Clarify awkward phrasing for include rules.Line 73 reads: "even if an include would otherwise match." The phrase "an include" is non-standard when used as a noun. Clarify by referring explicitly to "include rules" or restructure for readability.
-#### Include vs. exclude -- **Include rules** explicitly allow the experiment to run when matched. -- **Exclude rules** prevent the experiment from running when matched, even if an include would otherwise match. +#### Include vs. exclude +- **Include rules** explicitly allow the experiment to run when matched. +- **Exclude rules** prevent the experiment from running when matched, even if an include rule would otherwise match.
163-171: Standardise British vs. American English spelling.The section heading (line 163) uses "Finalize" (American English) whilst the instruction (line 170) uses "Finalise" (British English). Standardise to one variant for consistency throughout the documentation.
Recommended: Use American English ("Finalize") for consistency with typical tech documentation conventions, or confirm the repository's language preference and apply it uniformly.
-## Create the Draft and Finalize the Setup on the Web Console +## Create the Draft and Finalise the Setup on the Web ConsoleOr vice versa if the repository standard is American English.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/LaunchPad Browser Extension/_category_.json(1 hunks)docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...he experiment. | Unless you have a good reason keep it at 100%. | | Unit Type *| D...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~23-~23: The modal verb ‘can’ requires the verb’s base form.
Context: ...ent will run. | The same experiment can runs across multiple apps or sites. | | **Ow...
(MD_BASEFORM)
[uncategorized] ~33-~33: Did you mean: “By default,”?
Context: ...ant and one or more treatment variants. By default experiments are creating with 1 treamen...
(BY_DEFAULT_COMMA)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...lly between all the variants. To change this you can open the experiment on the web ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~73-~73: 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)
[duplication] ~75-~75: Possible typo: you repeated a word.
Context: ...herwise match. #### Combining multiple rules - Rules within the same group are evaluated usi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~143-~143: To elevate your writing, try using a synonym here.
Context: ...ment. | Target nearby elements that are hard to select directly. | Ideal for dynamic...
(HARD_TO)
[uncategorized] ~170-~170: 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)
⏰ 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/LaunchPad Browser Extension/_category_.json (1)
1-6: LGTM!Valid Docusaurus category configuration with appropriate properties for organising the LaunchPad Browser Extension documentation.
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (1)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (1)
71-71: Rephrase to avoid using "include" as a noun.Consider rephrasing for better readability and grammatical correctness.
-**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.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...he experiment. | Unless you have a good reason keep it at 100%. | | Unit Type *| D...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~23-~23: The modal verb ‘can’ requires the verb’s base form.
Context: ...ent will run. | The same experiment can runs across multiple apps or sites. | | **Ow...
(MD_BASEFORM)
[uncategorized] ~33-~33: Did you mean: “By default,”?
Context: ...ant and one or more treatment variants. By default experiments are creating with 1 treamen...
(BY_DEFAULT_COMMA)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...lly between all the variants. To change this you can open the experiment on the web ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~71-~71: 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)
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ...herwise match. #### Combining multiple rules - Rules within the same group are evaluated usi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~141-~141: To elevate your writing, try using a synonym here.
Context: ...ment. | Target nearby elements that are hard to select directly. | Ideal for dynamic...
(HARD_TO)
[uncategorized] ~168-~168: 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)
⏰ 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
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ## Variants | ||
|
|
||
| Each experiment requires at least a control variant and one or more treatment variants. By default experiments are creating with 1 treament variant. |
There was a problem hiding this comment.
Add comma after "By default".
Introductory adverbial phrases should be followed by a comma.
-Each experiment requires at least a control variant and one or more treatment variants. By default experiments are creating with 1 treament variant.
+Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant.📝 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 experiment requires at least a control variant and one or more treatment variants. By default experiments are creating with 1 treament variant. | |
| Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: Did you mean: “By default,”?
Context: ...ant and one or more treatment variants. By default experiments are creating with 1 treamen...
(BY_DEFAULT_COMMA)
🤖 Prompt for AI Agents
In docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
around line 33, the sentence "By default experiments are creating with 1
treament variant." is missing a comma after the introductory phrase "By
default"; update it to "By default, experiments are created with 1 treatment
variant." (also correct the grammar/typo "creating" → "created" and "treament" →
"treatment") to fix punctuation and clarity.
Correct spelling: "treament" → "treatment".
Typo in word spelling.
-Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are creating with 1 treament variant.
+Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant.Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: Did you mean: “By default,”?
Context: ...ant and one or more treatment variants. By default experiments are creating with 1 treamen...
(BY_DEFAULT_COMMA)
🤖 Prompt for AI Agents
In docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
around line 33, fix the typo "treament" to "treatment" so the sentence reads
correctly; update the word and run a quick spellcheck to ensure no other
misspellings remain.
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
| 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.
Ensure consistent spelling: use either "finalise" or "finalize" throughout.
The text mixes British ("Finalise" at line 168) and American ("finalize" at line 168 in the heading) spellings. Choose one variant and apply consistently across the documentation.
4. Finalise the setup on the web console (add metrics, etc)
+4. Finalize the setup on the web console (add metrics, etc)Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~168-~168: 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
In docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
around line 168, the word "Finalise" uses British spelling while the heading
uses American "finalize"; pick one spelling variant (e.g., change "Finalise" to
"Finalize" or vice versa) and update this line and any other occurrences in the
document to the chosen variant to ensure consistency throughout.
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (6)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (6)
25-25: Add missing comma after introductory clause.An introductory clause should be followed by a comma for clarity.
-| **Traffic Percentage** | The proportion of total eligible traffic that will be included in the experiment. | Unless you have a good reason keep it at 100%. | +| **Traffic Percentage** | The proportion of total eligible traffic that will be included in the experiment. | Unless you have a good reason, keep it at 100%. |
27-27: Fix grammar: "can runs" → "can run".The modal verb 'can' requires the verb's base form.
-| **Applications** | The applications where this experiment will run. | The same experiment can runs across multiple apps or sites. | +| **Applications** | The applications where this experiment will run. | The same experiment can run across multiple apps or sites. |
37-37: Correct punctuation, grammar and spelling in variants introduction.Multiple issues require correction in this sentence.
-Each experiment requires at least a control variant and one or more treatment variants. By default experiments are creating with 1 treament variant. +Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant.
45-45: Add missing comma after introductory clause.An introductory clause before the main clause should be followed by a comma.
-> **Note:** When using the LaunchPad, traffic is always split equally between all the variants. To change this you can open the experiment on the web console and change the traffic split. +> **Note:** When using the LaunchPad, traffic is always split equally between all the variants. To change this, you can open the experiment on the web console and change the traffic split.
107-109: Fix markdown table formatting: remove trailing pipe in separator row.The Global Defaults table separator row contains an extra pipe character that breaks alignment.
| Setting | Description | -|-------|--------------|------| +|-------|--------------| | **Use !important flag**| The changes will overwrite existing CSS. |
174-181: Standardise spelling: choose either "finalise" (British) or "finalize" (American).The document inconsistently uses both British and American spelling variants. Line 174 heading uses "Finalize" whilst line 181 uses "Finalise". Choose one variant and apply consistently throughout.
-## Create the Draft and Finalize the Setup on the Web Console +## Create the Draft and Finalise the Setup on the Web Console When configuration is complete: 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) +4. Finalize the setup on the web console (add metrics, etc)Recommendation: Since the document uses en-GB (British English based on context), maintain "Finalise" throughout and update the heading to match. Alternatively, standardise to American English ("Finalize") if that is your project convention.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
static/img/launchpad/create-dom-changes.pngis excluded by!**/*.pngstatic/img/launchpad/create-metadata.pngis excluded by!**/*.pngstatic/img/launchpad/create-url-targeting.pngis excluded by!**/*.pngstatic/img/launchpad/create-variants.pngis excluded by!**/*.pngstatic/img/launchpad/create-visual-editor.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...he experiment. | Unless you have a good reason keep it at 100%. | | Unit Type *| D...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~27-~27: The modal verb ‘can’ requires the verb’s base form.
Context: ...ent will run. | The same experiment can runs across multiple apps or sites. | | **Ow...
(MD_BASEFORM)
[uncategorized] ~37-~37: Did you mean: “By default,”?
Context: ...ant and one or more treatment variants. By default experiments are creating with 1 treamen...
(BY_DEFAULT_COMMA)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...lly between all the variants. To change this you can open the experiment on the web ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~80-~80: 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)
[duplication] ~82-~82: Possible typo: you repeated a word.
Context: ...herwise match. #### Combining multiple rules - Rules within the same group are evaluated usi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~154-~154: To elevate your writing, try using a synonym here.
Context: ...ment. | Target nearby elements that are hard to select directly. | Ideal for dynamic...
(HARD_TO)
[uncategorized] ~181-~181: 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)
⏰ 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
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (3)
113-113: Fix table cell formatting: remove extra asterisks.The cell contains extraneous markdown syntax. Past reviews flagged this, but it remains unresolved in the current code.
-| **Persist styles **| The changes will be reapplied after the JS framework (React/Vue/Angular) overwrites them. | +| **Persist styles** | The changes will be reapplied after the JS framework (React/Vue/Angular) overwrites them. |
176-184: Ensure consistent spelling: use "Finalize" throughout (American English).The section heading uses American spelling ("Finalize the Setup"), but line 183 uses British spelling ("Finalise"). Choose one variant and apply consistently.
-## Create the Draft and Finalize the Setup on the Web Console +## Create the Draft and Finalize the Setup on the Web Console When configuration is complete: 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) +4. Finalize the setup on the web console (add metrics, etc) 5. Start the experiment in web console
39-39: Fix grammar: "are creating" → "are created".This appears to have been flagged in past reviews but remains unresolved. The verb form should be past participle to match the present perfect tense structure.
-Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are creating with 1 treatment variant. +Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant.
🧹 Nitpick comments (2)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (2)
82-82: Clarify use of "include" as a noun; consider rewording.Using "include" as a noun ("even if an include would otherwise match") is non-standard. For clarity and precision, reword to use proper terminology.
-> **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.
156-156: Improve phrasing: replace "hard to select" with stronger alternative.Consider using more precise language than "hard to select" for better clarity and professional tone.
-| **Select Relative Element** | Switch the selection to a parent, sibling, or child element. | Target nearby elements that are hard to select directly. | Ideal for dynamic layouts or repeating structures. | +| **Select Relative Element** | Switch the selection to a parent, sibling, or child element. | Target nearby elements that are difficult to select directly. | Ideal for dynamic layouts or repeating structures. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/launchpad/superpower.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
[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)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...herwise match. #### Combining multiple rules - Rules within the same group are evaluated usi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~156-~156: To elevate your writing, try using a synonym here.
Context: ...ment. | Target nearby elements that are hard to select directly. | Ideal for dynamic...
(HARD_TO)
[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)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (2)
113-113: Remove extraneous asterisks from table cell.The cell contains malformed markdown with trailing asterisks that should be removed.
-| **Persist styles **| The changes will be reapplied after the JS framework (React/Vue/Angular) overwrites them. | +| **Persist styles** | The changes will be reapplied after the JS framework (React/Vue/Angular) overwrites them. |
39-39: Fix verb form: "are creating" → "are created".The sentence uses an incorrect verb form. Replace the present progressive with the past participle.
-Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are creating with 1 treatment variant. +Each experiment requires at least a control variant and one or more treatment variants. By default, experiments are created with 1 treatment variant.
🧹 Nitpick comments (1)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (1)
82-82: Restructure phrase to avoid non-standard noun usage.Using "include" as a noun in this context is non-standard. Rephrase to use standard terminology.
-**Include rules** explicitly allow the experiment to run when matched. +**Include rules** explicitly allow the experiment to run when conditions are matched.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
static/img/launchpad/create-visual-editor.pngis excluded by!**/*.pngstatic/img/launchpad/superpower.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx(1 hunks)docs/LaunchPad Browser Extension/installing-and-configuring-the-absmartly-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx
[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)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...herwise match. #### Combining multiple rules - Rules within the same group are evaluated usi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~156-~156: To elevate your writing, try using a synonym here.
Context: ...ment. | Target nearby elements that are hard to select directly. | Ideal for dynamic...
(HARD_TO)
[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)
⏰ 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/LaunchPad Browser Extension/installing-and-configuring-the-absmartly-launchpad.mdx (1)
1-11: LGTM! The installation guide is clear, concise, and well-structured. The frontmatter is correct and the step-by-step instructions provide an effective onboarding experience.docs/LaunchPad Browser Extension/creating-an-experiment-with-launchpad.mdx (1)
176-184: Standardise to consistent English spelling; amend heading and ensure all variants align.The document contains a genuine spelling inconsistency—the heading uses American English "Finalize" (line 176) whilst the body uses British English "Finalise" (line 183), and list item 3 uses American "behavior" (line 179).
However, the suggested diff is incomplete. To fully standardise on British English, the heading must also change to "Finalise". The corrected changes should be:
- Line 176:
Finalize→Finalise- Line 179:
behavior→behaviour- Line 183: already
Finalise(no change needed)Note: No documented language preference was found in the repository. Please confirm whether your organisation standardises on British English (en-GB) or American English (en-US), then apply consistently across this section and throughout the documentation.
- Fix title formatting: "Chromestore" → "Chrome Store" - Add Chrome Web Store screenshot - Add comprehensive DOM Changes SDK plugin configuration section with: - Installation instructions - Complete setup example - Configuration options documentation - How it works explanation
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/LaunchPad Browser Extension/installing-and-configuring-the-absmartly-launchpad.mdx (2)
31-59: Code example is well-structured, but consider adding error handling guidance.The basic setup code is clear and correctly demonstrates the plugin initialization flow. However, the documentation could benefit from a note about error handling, particularly for the
context.ready()anddomPlugin.ready()calls, to guide users on handling potential failures in production environments.Consider adding a brief callout or expanded example with try-catch error handling:
try { await context.ready(); const domPlugin = new DOMChangesPlugin({ context: context, autoApply: true, spa: true, visibilityTracking: true, debug: false, }); await domPlugin.ready(); } catch (error) { console.error('Failed to initialize DOM Changes plugin:', error); }
69-77: Consider adding a "Next Steps" section to guide users to the experiment setup guide.The installation and configuration documentation is complete, but it would be helpful to add a final section directing users to the companion guide (creating-an-experiment-with-launchpad.mdx) for the next phase of the workflow. This would improve the user journey through the documentation.
Consider adding a brief "Next Steps" section at the end:
## Next Steps Now that you've installed and configured the DOM Changes plugin, learn how to [create your first experiment with LaunchPad](./creating-an-experiment-with-launchpad.mdx).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/chrome-webstore-launchpad.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/LaunchPad Browser Extension/installing-and-configuring-the-absmartly-launchpad.mdx(1 hunks)
⏰ 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/LaunchPad Browser Extension/installing-and-configuring-the-absmartly-launchpad.mdx (2)
1-5: Frontmatter and imports look good.The YAML frontmatter is correctly formatted, and the sidebar position of 1 is appropriate for an installation guide. The relative import path for the Image component aligns with standard documentation structure.
69-77: Clear and comprehensive explanation of plugin behaviour.The "How It Works" section effectively summarises the plugin's functionality and ties back to the configuration options. It correctly explains SPA support and visibility tracking, reinforcing the practical value of the settings introduced earlier.
| # Installing the ABsmartly LaunchPad from the Chrome Store | ||
|
|
||
| 1. Go to https://chromewebstore.google.com/ | ||
| 2. Search for **ABsmartly LaunchPad** | ||
| 3. Click **Add to Chrome** | ||
|
|
||
| <Image | ||
| img="chrome-webstore-launchpad.png" | ||
| alt="ABsmartly LaunchPad in Chrome Web Store" | ||
| maxWidth="50rem" | ||
| centered | ||
| /> |
There was a problem hiding this comment.
🧩 Analysis chain
Verify image file path and external URL.
The installation instructions are clear and user-friendly. However, verify that the image "chrome-webstore-launchpad.png" exists in the correct location within the repository and that the Chrome Web Store URL remains current.
🏁 Script executed:
#!/bin/bash
# Description: Verify image asset exists in the LaunchPad Browser Extension docs directory.
# Search for the image file
fd -e png "chrome-webstore-launchpad" docs/Length of output: 0
🏁 Script executed:
#!/bin/bash
# Description: Search for image files in LaunchPad Browser Extension docs and check directory structure
# List all files in the LaunchPad Browser Extension directory
echo "=== Directory structure of LaunchPad Browser Extension docs ==="
fd . "docs/LaunchPad Browser Extension" --max-depth 3
# Search for any png files in docs
echo -e "\n=== All PNG files in docs directory ==="
fd -e png . docs/
# Check if images subdirectory exists
echo -e "\n=== Checking for images subdirectory ==="
ls -la "docs/LaunchPad Browser Extension/" 2>/dev/null || echo "Directory listing failed"Length of output: 735
🌐 Web query:
Chrome Web Store URL https://chromewebstore.google.com/ current 2025
💡 Result:
Yes — the Chrome Web Store's current primary URL is https://chromewebstore.google.com/. [1][2]
Alternative/legacy address: https://chrome.google.com/webstore still works (older version/redirect). [2]
Sources: Google announcement and coverage. [1][2]
Missing image asset: add chrome-webstore-launchpad.png or remove image reference.
The image file chrome-webstore-launchpad.png referenced in the documentation does not exist in the repository. No PNG files were found in the docs directory, and no images subdirectory exists within the LaunchPad Browser Extension folder. Either add the missing image file or remove the <Image> component from the documentation. The Chrome Web Store URL is current and valid.
🤖 Prompt for AI Agents
In docs/LaunchPad Browser
Extension/installing-and-configuring-the-absmartly-launchpad.mdx around lines 7
to 18 the Image component references chrome-webstore-launchpad.png which is
missing from the repo; either add the PNG at an appropriate docs assets path
(e.g., docs/LaunchPad Browser Extension/images/chrome-webstore-launchpad.png)
and update the Image img attribute to that relative path, or remove the <Image>
component and replace it with the Chrome Web Store link/text; ensure the chosen
option is committed so the markdown no longer points to a non-existent file.
joalves
force-pushed
the
LaunchPad-documentation
branch
from
7afc3c6 to
65740a9
Compare
- Add clickable link to extension page at the top of installation section - Replace screenshot with improved Chrome Web Store image
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (2)
docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx (2)
113-113: ** Remove trailing asterisks from table cell.**This issue was flagged in a previous review and marked as addressed, but the trailing asterisks remain in the provided code. The cell contains extraneous markdown syntax that should be removed.
-| **Persist styles **| The changes will be reapplied after the JS framework (React/Vue/Angular) overwrites them. | +| **Persist styles** | The changes will be reapplied after the JS framework (React/Vue/Angular) overwrites them. |
183-183: ** Use American English spelling: change "Finalise" to "Finalize".**The document uses American English throughout; however, line 183 uses British spelling. This was previously flagged and should be corrected for consistency.
-4. Finalise the setup on the web console (add metrics, etc) +4. Finalize the setup on the web console (add metrics, etc)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/launchpad/chrome-webstore-launchpad.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx(1 hunks)docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...tly Chrome Extension ### Installation First you need to install the LaunchPad as a ...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~35-~35: After the expression ‘for example’ a comma is usually used.
Context: ...er your ABsmartly endpoint address. For example https://demo-2.absmartly.com 4. Sele...
(COMMA_FOR_EXAMPLE)
docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx
[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)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...herwise match. #### Combining multiple rules - Rules within the same group are evaluated usi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~156-~156: To elevate your writing, try using a synonym here.
Context: ...ment. | Target nearby elements that are hard to select directly. | Ideal for dynamic...
(HARD_TO)
[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)
⏰ 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
docs/LaunchPad Browser Extension/creating-an-experiment-with-the-launchpad.mdx
Show resolved
Hide resolved
|
|
||
| # Getting started with the ABSmartly LaunchPad | ||
|
|
||
| Before you can use the ABsmartly's LaunchPad, you first need to install the Chrome extension and setup the SDK plugin. |
There was a problem hiding this comment.
Ensure consistent brand name capitalisation.
Line 9 uses "ABsmartly" but the correct capitalisation is "ABSmartly" (with capital S), as used elsewhere in the document.
-Before you can use the ABsmartly's LaunchPad, you first need to install the Chrome extension and setup the SDK plugin.
+Before you can use ABSmartly's LaunchPad, you first need to install the Chrome extension and set up the SDK plugin.Also note: "setup" should be "set up" (two words) when used as a verb.
📝 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.
| Before you can use the ABsmartly's LaunchPad, you first need to install the Chrome extension and setup the SDK plugin. | |
| Before you can use ABSmartly's LaunchPad, you first need to install the Chrome extension and set up the SDK plugin. |
🤖 Prompt for AI Agents
In docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx
around line 9, the brand name and verb usage are incorrect: change "ABsmartly"
to "ABSmartly" to match the project's capitalization, and change "setup the SDK
plugin" to "set up the SDK plugin" (two words) when used as a verb so the
sentence reads correctly.
|
|
||
| 1. Click on the LaunchPad's icon to open the extension | ||
| 2. Click **Configure Settings**. | ||
| 3. Enter your ABsmartly endpoint address. For example `https://demo-2.absmartly.com` |
There was a problem hiding this comment.
Add comma after "For example".
Line 35 should have a comma after "For example" per standard English punctuation.
-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` 📝 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.
| 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` |
🧰 Tools
🪛 LanguageTool
[typographical] ~35-~35: After the expression ‘for example’ a comma is usually used.
Context: ...er your ABsmartly endpoint address. For example https://demo-2.absmartly.com 4. Sele...
(COMMA_FOR_EXAMPLE)
🤖 Prompt for AI Agents
In docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx
around line 35, add a comma after the phrase "For example" so the sentence reads
"For example, `https://demo-2.absmartly.com`" to follow standard English
punctuation.
| 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 grammar error: "to applies" should be "to apply".
Line 47 contains a verb agreement error.
-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, fix the grammar error where the phrase "to applies the
DOM changes" incorrectly uses "applies"; change it to "to apply" so the sentence
reads "To make it possible for the ABsmartly SDK to apply the DOM changes to
your website..." and ensure surrounding punctuation and capitalization remain
correct.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx (4)
9-9: Fix brand capitalisation and verb form (previously flagged).This issue was raised in prior review but remains unresolved. Line 9 contains two errors:
- "ABsmartly's" should be "ABSmartly's" (capital S)
- "setup the SDK plugin" should be "set up the SDK plugin" (verb form requires two words)
Apply this diff:
-Before you can use the ABsmartly's LaunchPad, you first need to install the Chrome extension and setup the SDK plugin. +Before you can use ABSmartly's LaunchPad, you first need to install the Chrome extension and set up the SDK plugin.
35-35: Fix capitalisation and add missing comma (previously flagged).This issue was raised in prior review but remains unresolved. Line 35 has two errors:
- "ABsmartly endpoint address" should be "ABSmartly endpoint address"
- Missing comma after "For example"
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`
47-48: Fix verb agreement and brand capitalisation (previously flagged).This issue was raised in prior review but remains unresolved. Line 47 contains a verb agreement error:
"to applies" should be "to apply"
Additionally, "ABsmartly" should be "ABSmartly" (capital S).
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,
1-103: Standardise ABSmartly brand name capitalisation throughout the document.The document uses inconsistent capitalisation of the brand name, alternating between "ABsmartly" and the correct form "ABSmartly" (with capital S, as used in the title on line 7). Ensure consistent capitalisation throughout for professionalism and brand consistency.
Apply this comprehensive diff to standardise all instances:
-## The ABsmartly Chrome Extension +## The ABSmartly Chrome Extension-First you need to download and install the LaunchPad as a Chrome extension. This will make it possible to create DOM changes experiments using the Visual Editor. +First, you need to download and install the LaunchPad as a Chrome extension. This will make it possible to create DOM changes experiments using the Visual Editor.-2. Search for **ABsmartly LaunchPad** +2. Search for **ABSmartly LaunchPad**- alt="ABsmartly LaunchPad in Chrome Web Store" + alt="ABSmartly LaunchPad in Chrome Web Store"-5. Pin the **ABsmartly LaunchPad** +5. Pin the **ABSmartly LaunchPad**-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`-4. Select **JWT from Browser Cookie** to use the ABsmartly cookie. +4. Select **JWT from Browser Cookie** to use the ABSmartly cookie.-5. Click **Authenticate in ABsmartly** to connect to your ABsmartly's instance. +5. Click **Authenticate in ABSmartly** to connect to your ABSmartly's instance.-6. You are now ready to use the ABsmartly's LaunchPad to create new experiments. +6. You are now ready to use the ABSmartly's LaunchPad to create new experiments.-The LaunchPad provides a visual editor to create DOM changes which will be applied by the ABsmartly's SDK once the experiment is running. +The LaunchPad provides a visual editor to create DOM changes which will be applied by the ABSmartly's SDK once 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, -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.-- **context**: Your ABsmartly SDK context instance (required) +- **context**: Your ABSmartly SDK context instance (required)-This plugin works seamlessly with the ABsmartly LaunchPad extension, which allows you to create and manage DOM changes visually through your browser. +This plugin works seamlessly with the ABSmartly LaunchPad extension, which allows you to create and manage DOM changes visually through your browser.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...in. ## The ABsmartly Chrome Extension First you need to download and install the La...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~35-~35: After the expression ‘for example’ a comma is usually used.
Context: ...er your ABsmartly endpoint address. For example https://demo-2.absmartly.com 4. Sele...
(COMMA_FOR_EXAMPLE)
⏰ 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
| Before you can use the ABsmartly's LaunchPad, you first need to install the Chrome extension and setup the SDK plugin. | ||
|
|
||
| ## The ABsmartly Chrome Extension | ||
|
|
There was a problem hiding this comment.
Add comma after introductory phrase.
Line 12 is missing a comma after the introductory phrase "First". Per standard English punctuation, add a comma after introductory adverbs.
Apply this diff:
-First you need to download and install the LaunchPad as a Chrome extension.
+First, you need to download and install the LaunchPad as a Chrome extension.📝 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.
| First, you need to download and install the LaunchPad as a Chrome extension. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...in. ## The ABsmartly Chrome Extension First you need to download and install the La...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/LaunchPad Browser Extension/getting-started-with-the-launchpad.mdx
around line 12, the introductory adverb "First" is missing a trailing comma;
edit that line to insert a comma after "First" so it reads "First, ..." to
follow standard English punctuation for introductory phrases.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (8)
docs/web-console-docs/ownership-and-permissions.mdx (6)
9-20: Improve punctuation and conciseness in introduction paragraph.Lines 9 and 19 require commas before "in this document" and "you won't be able," respectively. Additionally, line 9 repeats the phrase "making use of" which appears elsewhere; consider rephrasing for variety. The en-GB spelling "organisation" is correct and should be retained.
Suggested improvements:
-Over the last few months we incrementally released many new features related to teams, ownership & collaboration aimed at improving how teams are experimenting and collaborating with each other. In this document we will discuss those changes and how you can start making use of them. +Over the last few months we incrementally released many new features related to teams, ownership and collaboration aimed at improving how teams are experimenting and collaborating with each other. In this document, we will discuss those changes and how you can start leveraging them. -:::info -**Action item**: If you have not done so yet, we encourage you to go to /settings/teams and start building a team structure which aligns with the way you are structured and operating (or any other which makes most sense from the organizational point of view). Unless you start building your team hierarchy in ABsmartly you won't be able to start making use of the new features described below. -::: +:::info +**Action item**: If you have not done so yet, we encourage you to go to /settings/teams and start building a team structure which aligns with the way you are structured and operating (or any other structure which makes most sense from an organisational perspective). Unless you start building your team hierarchy in ABsmartly, you won't be able to access the new features described below. +:::
26-42: Apply comma corrections to compound sentences in team ownership section.Multiple commas are missing before coordinating conjunctions connecting independent clauses:
- Line 30: Before "and" (resilience and management)
- Line 31: After "Because of this"
- Line 34: Before "but" (retain vs. add)
These follow standard en-GB compound sentence punctuation conventions.
-While this is often fine, in many cases it is preferable for assets like Experiment or Metrics to be owned by a team and not by an individual. +While this is often fine, in many cases it is preferable for assets like Experiments or Metrics to be owned by a team and not by an individual. -Team level ownership is more resilient to changes and it makes it easier to manage and share assets at scale. +Team level ownership is more resilient to changes, and it makes it easier to manage and share assets at scale. -Because of this we introduced team level ownership for `Experiments`, `Features`, `Templates`, `Goals` & `Metrics`. +Because of this, we introduced team level ownership for `Experiments`, `Features`, `Templates`, `Goals`, and `Metrics`. -For backward compatibility, existing assets will retain their current individual owners but it won't be possible to add new ones. +For backward compatibility, existing assets will retain their current individual owners, but it won't be possible to add new ones.
46-81: Fix punctuation and refine consistency in team membership section.Several comma placements require correction per en-GB compound sentence rules:
- Line 48: Add comma after "By default"
- Line 49: Add comma before "but"
- Line 70: Add comma before "but"
Additionally, the three role descriptions (lines 56–58) could be streamlined. Currently, each begins with "Team [role]:" which creates repetitive phrasing. Consider reformatting for conciseness.
-Together with the new team structure, you can now also assign members to those teams. +Together with the new team structure, you can now also assign members to those teams. -By default all platform users are members of the Global Team (feel free to rename it so it matches your company name) which represents your entire organisation but you can now also add them to their actual team in the team hierarchy. +By default, all platform users are members of the Global Team (feel free to rename it to match your company name), which represents your entire organisation, but you can now also add them to their actual team in the team hierarchy. -Team membership can be explicit when a user is directly added to a team but it can also be implicit when inherited. +Team membership can be explicit when a user is directly added to a team, but it can also be implicit when inherited. -:::info -**Future plans**: We do have plans to add new pre-defined custom roles (ie: Can Review, Can Start) and possibly the ability to create custom team level roles. -::: +:::info +**Future plans:** We plan to add pre-defined custom roles (e.g., Can Review, Can Start) and possibly the ability to create custom team-level roles. +:::
83-101: Correct comma placement in global team permissions section.Two comma placements require correction:
- Line 89: Add comma before "but" in compound sentence
- Line 99: Add comma after "If" per en-GB style guidelines
-For backward compatibility, it is still possible to assign permissions to `Experiments`, `Features`, `Templates`, `Goals` & `Metrics` at the Global Team level but it is not recommended as it would interfere and overwrite anything specified at the team level. +For backward compatibility, it is still possible to assign permissions to `Experiments`, `Features`, `Templates`, `Goals`, and `Metrics` at the Global Team level, but it is not recommended as it would interfere with and overwrite anything specified at the team level. -:::info -**Action Item**: Review your current roles & permissions to align with the new model (Ideally no global roles, besides the fulladmin role, should grant permissions to `Experiments`, `Features`, `Templates`, `Goals` & `Metrics`) and start migrating your user from the `User` role to the new `Base User`. -If you need help automating this step please let us know. Once the migration is done, you can let us know so we can remove it and make `Base User` the new default role for all new users. -::: +:::info +**Action Item**: Review your current roles and permissions to align with the new model (ideally, no global roles besides the fulladmin role should grant permissions to `Experiments`, `Features`, `Templates`, `Goals`, and `Metrics`), and start migrating your users from the `User` role to the new `Base User` role. If you need help automating this step, please let us know. Once the migration is complete, you can notify us so we can remove it and make `Base User` the new default role for all new users. +:::
104-128: Refine punctuation and wording in asset sharing section.Multiple punctuation and style improvements are needed:
- Line 106: Add comma before "but"
- Line 109: Add comma after "To address this"
- Line 112: Add comma before second "or" clause
- Line 119: Note structure looks correct; no change needed
- Line 123: Add comma after "For example," and simplify "It is possible that" to "You may"
- Line 124: Add comma before "and"; the current sentence is too long
- Line 126: Simplify "Future plans" heading
-All the features described above enable users to collaborate within their team but it does not allow them to share assets with other teams or individuals. +All the features described above enable users to collaborate within their team, but they do not allow sharing of assets with other teams or individuals. -For example a team owning a metric wants to make this metric available to all teams in Engineering or a team working on an experiment wants to allow specific users from other teams to collaborate on that experiment without making them owners. +For example, a team owning a metric may wish to make it available to all teams in Engineering, or a team working on an experiment may wish to allow specific users from other teams to collaborate without granting ownership. -To address this we introduced Asset level permissions (for `Experiments`, `Features`, `Templates`, `Goals` & `Metrics`) which is the ability to share an asset with other teams or individuals. +To address this, we introduced asset-level permissions (for `Experiments`, `Features`, `Templates`, `Goals`, and `Metrics`), which enable sharing assets with other teams or individuals. -For now there are 2 types of possible permissions associated with sharing of assets. +Currently, there are two types of permissions associated with asset sharing: -A good use case for this is if you want to make your metric or a template available to another team or if you want other people to be able to view your experiment on the search page without being able to edit it. +A good use case is making your metric or template available to another team, or allowing others to view your experiment on the search page without editing rights. -:::note -**Note**: If Can View or Can Edit is granted to a team, then all members of that team will be able to view/edit that asset irrespective of their role in that team. Following the least privilege principle, and unless there is a good reason, it is usually good practice to grant Can Edit only to relevant individuals. -::: +:::note +**Note**: When Can View or Can Edit is granted to a team, all team members can view or edit that asset regardless of their team role. Following the principle of least privilege, grant Can Edit only to relevant individuals unless there is a compelling reason to do otherwise. +::: -:::info -**Action Item:** Go over your list of Experiments, Features, Templates, Goals & Metrics that you own (or that your team owns) and make sure to share it with the relevant individual(s) or team(s). For example if you want a metric or a goal to be available for everybody to use, then share it with the Global Team with Can View permission. -It is possible that you want all your existing metrics, goals and possibly all your experiments, features and templates to be discoverable and usable by anyone on the platform. If this is the case, just let us know and we will run a script to automatically grant Can View to all your existing assets saving you loads of manual work. - -**Future plans**: Let us know if you wish to see other types of permissions besides can view and can edit. -::: +:::info +**Action Item:** Review your Experiments, Features, Templates, Goals, and Metrics (those you own or your team owns) and share them with relevant individuals or teams. For example, to make a metric or goal available platform-wide, share it with the Global Team with Can View permission. + +You may want all existing metrics, goals, experiments, features, and templates to be discoverable and usable by all users. If so, please let us know; we can run a script to automatically grant Can View permissions to all your existing assets, saving significant manual effort. + +**What's next**: Let us know if you'd like to see additional permission types beyond Can View and Can Edit. +:::
131-132: "Next steps" section appears incomplete.The final section heading "## Next steps" (line 131) has no content. Either add relevant closing guidance or remove the section heading.
docs/platform-release-notes/2025/11.mdx (2)
17-35: Improve punctuation and conciseness in ownership & permissions section.Several punctuation and style improvements are needed:
- Line 19: Add comma after "In this release"
- Line 28: The phrase "make use of" is repetitive; consider "benefit from" or "leverage"
- Line 31: This paragraph contains three successive sentences starting with "We," creating repetitive structure. Consolidate or vary sentence openings.
- Line 31: Hyphenate "future-proof" (not "future proof")
- Line 31: Simplify "a lot of changes" to "many changes"
- Line 34: Restructure for clarity and politeness
The en-GB spelling "realise" (line 31) is correct and should be retained.
-We introduced a lot of changes but unless you take action on all the action items described above +We have introduced many changes; however, unless you take action on the 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. +nothing should change (except Team Ownership, which is now the default but can be disabled in settings), and you can continue using the platform as you do 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. +When you're ready to leverage these new features, please let us know. If you need help with any of the steps described above, we're here to assist. -In this release we make it possible to share **experiments**, **features**, **templates**, **goals** and **metrics** with users and teams so they collaborate and make use of those assets. +In this release, we enable sharing of **experiments**, **features**, **templates**, **goals**, and **metrics** with users and teams, enabling collaboration and effective use of these assets. -This was the last building block in our Ownership & Permission model. Some changes will be necessary on your side before you can fully make use of this new model. +This completes our Ownership & Permissions model. Some changes will be necessary on your side before you can fully benefit from this new model.
51-53: Minor refinements to closing section.The closing is appropriate but could be slightly refined for politeness and punctuation:
-As usual, let us know what you think and if you have any questions +As always, please let us know your thoughts and if you have any questions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
static/img/ownership-model/invite-user.pngis excluded by!**/*.pngstatic/img/ownership-model/shared-asset.pngis excluded by!**/*.pngstatic/img/ownership-model/team-members-with-roles.pngis excluded by!**/*.pngstatic/img/ownership-model/team-roles.pngis excluded by!**/*.pngstatic/img/ownership-model/team-structure.pngis excluded by!**/*.pngstatic/img/release-notes/sharing-assets.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/platform-release-notes/2025/11.mdx(1 hunks)docs/web-console-docs/ownership-and-permissions.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/11.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...e you to give it a try. Before you get started see our guides on [getting started with...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~19-~19: It appears that a comma is missing.
Context: ...ions model - Sharing of Assets In this release we make it possible to share **experime...
(DURING_THAT_TIME_COMMA)
[style] ~28-~28: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...ssary on your side before you can fully make use of this new model. We encourage you to rea...
(REP_MAKE_USE_OF)
[style] ~31-~31: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future proof for you. We realise th...
(MAKE_STYLE_BETTER)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...ges. We want to make things better and future proof for you. We realise that we introduced ...
(EN_COMPOUNDS_FUTURE_PROOF)
[style] ~31-~31: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~31-~31: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~31-~31: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
[style] ~34-~34: Consider using polite language here.
Context: ... making use of the new functionalities, let us know and if you need help for example with s...
(INSERT_PLEASE)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...ionalities, let us know and if you need help for example with some of the steps desc...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~53-~53: Consider using polite language here.
Context: ... ## Questions or Feedback? As usual, let us know what you think and if you have any ques...
(INSERT_PLEASE)
docs/web-console-docs/ownership-and-permissions.mdx
[typographical] ~9-~9: It appears that a comma is missing.
Context: ... collaborating with each other. In this document we will discuss those changes and how y...
(DURING_THAT_TIME_COMMA)
[style] ~9-~9: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...uss those changes and how you can start making use of them. ## Team structure The first bu...
(REP_MAKE_USE_OF)
[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)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...u start building your team hierarchy in ABsmartly you won't be able to start making use o...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~29-~29: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...d the item). While this is often fine, in many cases it is preferable for assets like Experi...
(IN_MANY_STYLE_CASES)
[uncategorized] ~30-~30: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...l ownership is more resilient to changes and it makes it easier to manage and share ...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~31-~31: It appears that a comma is missing.
Context: ... and share assets at scale. Because of this we introduced team level ownership for ...
(BECAUSE_OF_YOU_COMMA)
[uncategorized] ~34-~34: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...l retain their current individual owners but it won't be possible to add new ones. ...
(COMMA_COMPOUND_SENTENCE)
[style] ~41-~41: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...trics to the most relevant team in your organisation. To do that, just edit assets that you ...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~41-~41: Consider a more expressive alternative.
Context: ... relevant team in your organisation. To do that, just edit assets that you current...
(DO_ACHIEVE)
[uncategorized] ~48-~48: Did you mean: “By default,”?
Context: ...now also assign members to those teams. By default all platform users are members of the G...
(BY_DEFAULT_COMMA)
[style] ~49-~49: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...pany name) which represents your entire organisation but you can now also add them to their ...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~49-~49: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...hich represents your entire organisation but you can now also add them to their actu...
(COMMA_COMPOUND_SENTENCE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...hare all assets owned by that team. - Team Admin: Same as Team Contributor + the...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~70-~70: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... when a user is directly added to a team but it can also be implicit when inherited....
(COMMA_COMPOUND_SENTENCE)
[style] ~77-~77: ‘Future plans’ might be wordy. Consider a shorter alternative.
Context: ...can interact with the team's assets. Future plans: We do have plans to add new pre-defi...
(EN_WORDINESS_PREMIUM_FUTURE_PLANS)
[uncategorized] ~89-~89: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ls&Metrics` at the Global Team level but it is not recommended as it would inter...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~99-~99: It seems that a comma is missing.
Context: .... If you need help automating this step please let us know. Once the migration is done...
(IF_PLEASE_COMMA)
[uncategorized] ~106-~106: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e users to collaborate within their team but it does not allow them to share assets ...
(COMMA_COMPOUND_SENTENCE)
[style] ~107-~107: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ring or a team working on an experiment wants to allow specific users from other teams t...
(REP_WANT_TO_VB)
[typographical] ~109-~109: It seems that a comma is missing.
Context: ...without making them owners. To address this we introduced Asset level permissions (...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~112-~112: Possible missing comma found.
Context: ...tric or a template available to another team or if you want other people to be able ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~119-~119: It seems that a pronoun is missing.
Context: ..." maxWidh="20rem" /> :::note Note: If Can View or Can Edit is granted to a te...
(IF_VB)
[typographical] ~123-~123: After the expression ‘for example’ a comma is usually used.
Context: ... relevant individual(s) or team(s). For example if you want a metric or a goal to be av...
(COMMA_FOR_EXAMPLE)
[style] ~123-~123: For conciseness, try rephrasing this sentence.
Context: ...e Global Team with Can View permission. It is possible that you want all your existing metrics, goals and po...
(MAY_MIGHT_BE)
[uncategorized] ~124-~124: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...m. If this is the case, just let us know and we will run a script to automatically g...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~124-~124: Possible missing comma found.
Context: ...lly grant Can View to all your existing assets saving you loads of manual work. **Fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~126-~126: ‘Future plans’ might be wordy. Consider a shorter alternative.
Context: ...ets saving you loads of manual work. Future plans: Let us know if you wish to see other...
(EN_WORDINESS_PREMIUM_FUTURE_PLANS)
[style] ~126-~126: Consider using polite language here.
Context: ...oads of manual work. Future plans: Let us know if you wish to see other types of permi...
(INSERT_PLEASE)
⏰ 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/platform-release-notes/2025/11.mdx (1)
36-45: Section is well-structured and clear.The improved experiment search list section is well-formatted with clear bullet points explaining filter changes. Information is appropriate and easy to follow. No changes required.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/platform-release-notes/2025/11.mdx (2)
13-15: Address placeholder content and missing punctuation in LaunchPad section.This section contains two unresolved issues from the previous review:
- Line 13: Missing comma after "try." – should read "...give it a try, Before you get started..."
- Line 15: "VIDEO OF JONAS" is a placeholder that must be replaced with an actual video embed/link or removed entirely before publication.
Please clarify the intended content and apply the necessary edits.
Suggested fix:
While the Chrome Extension is still in Beta, we encourage you to give it a try. - -Before you get started see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). - -VIDEO OF JONAS +Before you get started, see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). + +[Include video embed or link here, or delete this line if not available]
46-49: Complete or remove the "Data Retention Update" section.The "Data Retention Update" section introduced at line 46 remains incomplete, containing only a fragment on line 48. This must be either fully developed with substantive details or removed entirely before publication.
If retaining this section, include: what changed (policy/retention period/data types affected), the business reason, any key dates (effective, migration, deletion), and user actions required (e.g., how to request data, opt-outs, or support contact).
🧹 Nitpick comments (2)
docs/platform-release-notes/2025/11.mdx (2)
28-34: Refine language in Ownership & Permissions section for clarity and conciseness.The phrasing in these lines can be improved to reduce repetition and strengthen the message. Key suggestions:
- Line 28: Avoid repeating "make use of" (also appears line 29)
- Line 31: "future proof" should be hyphenated as "future-proof"; also reconsider British spelling ("realise" is acceptable but be consistent with document style)
- Line 31: Three successive sentences begin with "We" – consider restructuring for variety
- Line 34: Add "please" for politeness, and add a comma after "functionalities"
Suggested refactor:
This was the last building block in our Ownership & Permission model. Some changes will be necessary on your side before you can fully make use of this new model. -We encourage you to read our [how-to guide](/docs/web-console-docs/ownership-and-permissions) and to reach out to us if necessary so we can jump on a call and guide you through those changes. +Please read our [how-to guide](/docs/web-console-docs/ownership-and-permissions) and reach out if you need guidance. -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. +We want to make things better and future-proof for you. We recognise that many changes have been introduced, but unless you act on the action items above, nothing will change (except Team Ownership, which is now the default but can be disabled in settings) and you can continue using the platform as before. -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. +When you're ready to use these new features, please let us know if you need help with any of the steps above.
13-13: Correct comma placement in two sentences.LanguageTool has flagged missing commas in:
- Line 13: "Before you get started see" should be "Before you get started, see"
- Line 19: "In this release we make it possible" should be "In this release, we make it possible"
-Before you get started see our guides +Before you get started, see our guides -In this release we make it possible to share +In this release, we make it possible to shareAlso applies to: 19-19
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/platform-release-notes/2025/11.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/11.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...e you to give it a try. Before you get started see our guides on [getting started with...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~19-~19: It appears that a comma is missing.
Context: ...ions model - Sharing of Assets In this release we make it possible to share **experime...
(DURING_THAT_TIME_COMMA)
[style] ~28-~28: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...ssary on your side before you can fully make use of this new model. We encourage you to rea...
(REP_MAKE_USE_OF)
[style] ~31-~31: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future proof for you. We realise th...
(MAKE_STYLE_BETTER)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...ges. We want to make things better and future proof for you. We realise that we introduced ...
(EN_COMPOUNDS_FUTURE_PROOF)
[style] ~31-~31: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~31-~31: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~31-~31: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
[style] ~34-~34: Consider using polite language here.
Context: ... making use of the new functionalities, let us know and if you need help for example with s...
(INSERT_PLEASE)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...ionalities, let us know and if you need help for example with some of the steps desc...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~53-~53: Consider using polite language here.
Context: ... ## Questions or Feedback? As usual, let us know what you think and if you have any ques...
(INSERT_PLEASE)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 5
♻️ Duplicate comments (2)
docs/platform-release-notes/2025/11.mdx (2)
19-19: Replace or remove placeholder content before publication.Line 19 contains "VIDEO OF JONAS", which is a placeholder reference. This content is not suitable for publication and must be either replaced with an actual video embed/link or removed entirely.
As flagged in the previous review, determine whether a video should be embedded here or if this section should be deleted.
If a video exists, replace line 19 with an appropriate video embed or link reference. If no video is available, remove lines 17–19 entirely.
13-21: Address punctuation and sentence structure issues.Lines 13–21 contain several missing commas that affect readability:
- Line 13: Should be "give it a try." followed by "Before" as a new sentence, or combine with comma
- Line 15: Sentence beginning needs revision for clarity
- Line 17: Missing comma before "You can also watch this video"
- Line 21: Transition after placeholder needs clarification once placeholder is resolved
These punctuation issues should be resolved alongside the placeholder replacement.
-While the Chrome Extension is still in Beta, we encourage you to give it a try. +While the Chrome Extension is still in Beta, we encourage you to give it a try. -Before you get started see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). +Before you get started, see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). -You can also watch this video where Jonas takes you through the process of creating a simple experiment. +You can also watch this video where Jonas takes you through the process of creating a simple experiment.Once the "VIDEO OF JONAS" placeholder is replaced or removed, review the surrounding sentences for optimal flow.
🧹 Nitpick comments (1)
docs/platform-release-notes/2025/11.mdx (1)
52-53: Consider more formal verb choice for consistency.Lines 52–53 use "Fixed" twice in bullet points. For more formal documentation, consider using "Resolved" or "Corrected" for consistency with professional release notes style.
-- Fixed the issue where reporting on the impact of GST experiments was not correct on the experiment list. -- Fixed an issue so the color of the impact of inconclusive experiments is gray as on the experiment's overview page. +- Resolved an issue where reporting on the impact of GST experiments was incorrect on the experiment list. +- Resolved an issue so the colour of the impact of inconclusive experiments is displayed as gray, consistent with the experiment's overview page.(Note: Using British English "colour" to match "en-GB" context.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/platform-release-notes/2025/11.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/11.mdx
[uncategorized] ~15-~15: Possible missing comma found.
Context: ... and give us feedback. Before you get started see our guides on [getting started with...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...he-launchpad). You can also watch this video where Jonas takes you through the proce...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...S This first release is only the first step as we have big plans for the **ABsmartl...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~25-~25: It appears that a comma is missing.
Context: ...ions model - Sharing of Assets In this release we make it possible to share **experime...
(DURING_THAT_TIME_COMMA)
[style] ~35-~35: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...ssary on your side before you can fully make use of this new model. We encourage you to rea...
(REP_MAKE_USE_OF)
[style] ~38-~38: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future proof for you. We realise th...
(MAKE_STYLE_BETTER)
[misspelling] ~38-~38: This word is normally spelled with a hyphen.
Context: ...ges. We want to make things better and future proof for you. We realise that we introduced ...
(EN_COMPOUNDS_FUTURE_PROOF)
[style] ~38-~38: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~38-~38: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~38-~38: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
[style] ~41-~41: Consider using polite language here.
Context: ... making use of the new functionalities, let us know and if you need help for example with s...
(INSERT_PLEASE)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...ionalities, let us know and if you need help for example with some of the steps desc...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~52-~52: Consider using a different verb for a more formal wording.
Context: ...ical significance of the experiments - Fixed the issue where reporting on the impact...
(FIX_RESOLVE)
[style] ~53-~53: Consider using a different verb for a more formal wording.
Context: ...s not correct on the experiment list. - Fixed an issue so the color of the impact of ...
(FIX_RESOLVE)
[style] ~57-~57: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...ur ongoing work on performance and cost optimisation we are planning to introduce the follow...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~67-~67: Consider using polite language here.
Context: ... ## Questions or Feedback? As usual, let us know what you think and if you have any ques...
(INSERT_PLEASE)
⏰ 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/platform-release-notes/2025/11.mdx (2)
1-2: Import statement is correct.The Image component import is properly set up and used appropriately in the document.
55-62: Data Retention Update section is now complete.This section has been properly developed compared to the previous version and contains substantive information about planned data retention policies. The content clearly outlines the two key changes and invites user feedback, which is appropriate for a release note.
The spelling "optimisation" is correct British English and aligns with the en-GB context.
| 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. |
There was a problem hiding this comment.
Improve sentence structure and style consistency.
Line 38 has multiple style and formatting issues:
- "future proof" should be hyphenated as "future-proof"
- Successive sentences begin with "We", which is repetitive
- "realise" is British English (acceptable), but consider "realize" if the target audience is primarily US-based
- "a lot of changes" can be more concise
Additionally, the sentence spanning lines 38–39 is difficult to parse and would benefit from clearer structure.
-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.
+We want to make things better and future-proof for you. We recognise that many changes have been introduced, but unless you take action on all the action items described above, nothing should change (except for Team Ownership, which is now the default but can be disabled in your settings) and you will be able to keep using the platform as you do today.📝 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.
| 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. | |
| We want to make things better and future-proof for you. We recognise that many changes have been introduced, but unless you take action on all the action items described above, nothing should change (except for Team Ownership, which is now the default but can be disabled in your settings) and you will be able to keep using the platform as you do today. |
🧰 Tools
🪛 LanguageTool
[style] ~38-~38: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future proof for you. We realise th...
(MAKE_STYLE_BETTER)
[misspelling] ~38-~38: This word is normally spelled with a hyphen.
Context: ...ges. We want to make things better and future proof for you. We realise that we introduced ...
(EN_COMPOUNDS_FUTURE_PROOF)
[style] ~38-~38: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~38-~38: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~38-~38: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
🤖 Prompt for AI Agents
In docs/platform-release-notes/2025/11.mdx around lines 38–39, the sentence is
clunky and has style issues: change "future proof" to "future-proof", avoid
repeating "We" by merging or splitting clauses into clearer sentences, replace
"a lot of changes" with a concise phrase like "many changes" or "numerous
changes", consider switching "realise" to US spelling "realize" if targeting a
US audience, and restructure the sentence into two simpler sentences so the
meaning is easier to parse (e.g., one sentence stating the intent to improve and
future-proof, and a second sentence explaining that no behavior will change
unless users act, with the exception of Team Ownership which is now default but
can be disabled).
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/platform-release-notes/2025/11.mdx (2)
7-7: Fix typo: "experiemntation" → "experimentation".Line 7 contains a spelling error that must be corrected before publication.
-This new release is packed with new features and improvements to help you manage your experiemntation program and make it easier to create simple experiments without the need for developers +This new release is packed with new features and improvements to help you manage your experimentation program and make it easier to create simple experiments without the need for developers
18-20: Replace or remove the "VIDEO OF JONAS" placeholder before publication.Line 20 contains a placeholder reference that cannot be published as-is. Either replace it with an embedded video component, a direct link to the video, or remove the section entirely.
If a video is available, apply this diff to embed or link it:
You can also watch this video where Jonas takes you through the process of creating a simple experiment. -VIDEO OF JONAS +[Insert embedded video component or link here]Alternatively, if no video is available, remove the entire section:
-You can also watch this video where Jonas takes you through the process of creating a simple experiment. - -VIDEO OF JONAS
🧹 Nitpick comments (5)
docs/platform-release-notes/2025/11.mdx (4)
14-16: Add missing comma after "try." and before "Before".Lines 14–16 require punctuation correction for proper sentence separation and readability.
-While the Chrome Extension is still in Beta, we encourage you to give it a try and give us feedback. +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](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). +Before you get started, see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad).
28-28: Add missing comma after opening phrase.Line 28 requires a comma after "In this release" for proper punctuation and readability.
-In this release we make it possible to share **experiments**, **features**, **templates**, **goals** and **metrics** with users and teams. +In this release, we make it possible to share **experiments**, **features**, **templates**, **goals** and **metrics** with users and teams.
41-44: Refactor for clarity, hyphenation, and polite tone.Lines 41–44 contain multiple style improvements needed: hyphenate "future-proof", avoid repeating sentence starters, condense "a lot of changes", add missing comma, and improve politeness.
-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. +We want to make things better and future-proof for you. We recognise that many changes have been introduced; however, unless you take action on all the action items described above, nothing should change (except for Team Ownership, which is now the default but can be disabled in your settings), and you will be able to keep using the platform as you do 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. +When you are ready to start making use of the new functionalities, please let us know, and if you need help with any of the steps described above, we're happy to assist.
72-74: Add polite phrasing and punctuation to closing section.The closing statement needs more courteous language and proper punctuation.
-## Questions or Feedback? +## Questions or Feedback? -As usual, let us know what you think and if you have any questions +As usual, please let us know what you think, and if you have any questions, please get in touch.docs/web-console-docs/ownership-and-permissions.mdx (1)
9-49: Address British/American English consistency and key grammar issues throughout.The document uses British English spellings (e.g., "organisation", "realise") and has several missing commas in compound sentences. For professional consistency across your documentation suite, consider standardising spelling and completing punctuation.
Key improvements suggested:
British → American English (if your project standard is US English):
- Line 14: "organisation" → "organization"
- Line 41: "organisation" → "organization"
- Line 49: "organisation" → "organization"
Add missing commas in compound sentences (lines 14, 30, 34, 49, 71, 87, 104):
- Line 14: Add comma before "so" (independent clauses)
- Line 30: Add comma before "and"
- Line 34: Add comma before "but"
- Line 49: Add comma before "but"
- Line 71: Add comma before "but"
- Line 87: Add comma before "but"
- Line 104: Add comma before "but"
Minor sentence polish:
- Line 48: "By default," (add comma after introductory phrase)
- Line 122: "For example," (add comma after introductory phrase)
Run a find-and-replace or use a linter with your project's English standard (e.g.,
en-USvsen-GB) to address these systematically.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/platform-release-notes/2025/11.mdx(1 hunks)docs/web-console-docs/ownership-and-permissions.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/11.mdx
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... and give us feedback. Before you get started see our guides on [getting started with...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...he-launchpad). You can also watch this video where Jonas takes you through the proce...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...S This first release is only the first step as we have big plans for the **ABsmartl...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~28-~28: It appears that a comma is missing.
Context: ...ions model - Sharing of Assets In this release we make it possible to share **experime...
(DURING_THAT_TIME_COMMA)
[style] ~41-~41: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future proof for you. We realise th...
(MAKE_STYLE_BETTER)
[misspelling] ~41-~41: This word is normally spelled with a hyphen.
Context: ...ges. We want to make things better and future proof for you. We realise that we introduced ...
(EN_COMPOUNDS_FUTURE_PROOF)
[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~41-~41: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~41-~41: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
[style] ~44-~44: Consider using polite language here.
Context: ... making use of the new functionalities, let us know and if you need help for example with s...
(INSERT_PLEASE)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...ionalities, let us know and if you need help for example with some of the steps desc...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~57-~57: Consider using a different verb for a more formal wording.
Context: ...ical significance of the experiments - Fixed the issue where reporting on the impact...
(FIX_RESOLVE)
[style] ~58-~58: Consider using a different verb for a more formal wording.
Context: ...s not correct on the experiment list. - Fixed an issue so the color of the impact of ...
(FIX_RESOLVE)
[style] ~64-~64: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...ur ongoing work on performance and cost optimisation we are planning to introduce the follow...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~74-~74: Consider using polite language here.
Context: ... ## Questions or Feedback? As usual, let us know what you think and if you have any ques...
(INSERT_PLEASE)
docs/web-console-docs/ownership-and-permissions.mdx
[typographical] ~9-~9: It appears that a comma is missing.
Context: ... collaborating with each other. In this document we will discuss those changes and how y...
(DURING_THAT_TIME_COMMA)
[style] ~9-~9: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...uss those changes and how you can start making use of them. ## Team structure The first bu...
(REP_MAKE_USE_OF)
[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)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...u start building your team hierarchy in ABsmartly you won't be able to start making use o...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~29-~29: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...d the item). While this is often fine, in many cases it is preferable for assets like Experi...
(IN_MANY_STYLE_CASES)
[uncategorized] ~30-~30: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...l ownership is more resilient to changes and it makes it easier to manage and share ...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~31-~31: It appears that a comma is missing.
Context: ... and share assets at scale. Because of this we introduced team level ownership for ...
(BECAUSE_OF_YOU_COMMA)
[uncategorized] ~34-~34: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...l retain their current individual owners but it won't be possible to add new ones. ...
(COMMA_COMPOUND_SENTENCE)
[style] ~41-~41: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...trics to the most relevant team in your organisation. To do that, just edit assets that you ...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~41-~41: Consider a more expressive alternative.
Context: ... relevant team in your organisation. To do that, just edit assets that you current...
(DO_ACHIEVE)
[uncategorized] ~48-~48: Did you mean: “By default,”?
Context: ...now also assign members to those teams. By default all platform users are members of the G...
(BY_DEFAULT_COMMA)
[style] ~49-~49: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...pany name) which represents your entire organisation but you can now also add them to their ...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~49-~49: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...hich represents your entire organisation but you can now also add them to their actu...
(COMMA_COMPOUND_SENTENCE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...hare all assets owned by that team. - Team Admin: Same as Team Contributor + the...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~71-~71: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... when a user is directly added to a team but it can also be implicit when inherited....
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~87-~87: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ls&Metrics` at the Global Team level but it is not recommended as it would inter...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~97-~97: It seems that a comma is missing.
Context: .... If you need help automating this step please let us know. Once the migration is done...
(IF_PLEASE_COMMA)
[uncategorized] ~104-~104: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e users to collaborate within their team but it does not allow them to share assets ...
(COMMA_COMPOUND_SENTENCE)
[style] ~105-~105: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ring or a team working on an experiment wants to allow specific users from other teams t...
(REP_WANT_TO_VB)
[typographical] ~107-~107: It seems that a comma is missing.
Context: ...without making them owners. To address this we introduced Asset level permissions (...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~110-~110: Possible missing comma found.
Context: ...tric or a template available to another team or if you want other people to be able ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~118-~118: It seems that a pronoun is missing.
Context: ... maxWidth="20rem" /> :::info Note: If Can View or Can Edit is granted to a te...
(IF_VB)
[typographical] ~122-~122: After the expression ‘for example’ a comma is usually used.
Context: ... relevant individual(s) or team(s). For example if you want a metric or a goal to be av...
(COMMA_FOR_EXAMPLE)
[style] ~122-~122: For conciseness, try rephrasing this sentence.
Context: ...e Global Team with Can View permission. It is possible that you want all your existing metrics, goals and po...
(MAY_MIGHT_BE)
[uncategorized] ~123-~123: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...m. If this is the case, just let us know and we will run a script to automatically g...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...lly grant Can View to all your existing assets saving you loads of manual work. :::
(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/ownership-and-permissions.mdx (1)
1-125: Documentation is comprehensive and well-structured.The ownership and permissions guide is thorough, clearly organised, and includes appropriate action items, backward compatibility notes, and visuals. The content effectively explains the new model and guides users through migration steps. Pending the grammar and English consistency refinements suggested above, this is ready for publication.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
docs/platform-release-notes/2025/11.mdx (4)
44-44: Add missing comma and polite phrasing.-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. +When you are ready to start making use of the new functionalities, please let us know, and if you need help with any of the steps described above, please get in touch.
41-42: Revise sentences to improve clarity, reduce repetition, and maintain consistent tone.The passage contains several stylistic issues: repeated sentence openings with "We", British spelling "realise" (acceptable but inconsistent with likely US audience), vague phrasing "a lot of changes", and overly complex structure. Previous reviews marked this as addressed, but the issues remain.
Apply this diff to clarify the passage:
-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. +We want to make the platform better and future-proof for you. Whilst we have introduced many changes, nothing will change unless you act on the items above (except Team Ownership, now the default but configurable in settings). You will be able to continue using the platform as you do today.
20-20: Remove or replace the placeholder "VIDEO OF JONAS".Line 20 contains a literal placeholder that must be replaced before publication. Either provide an embedded video component, a hyperlinked video URL, or remove the line entirely if no video is available.
Apply one of the following diffs depending on your intention:
Option 1 (if removing):
-You can also watch this video where Jonas takes you through the process of creating a simple experiment. - -VIDEO OF JONASOption 2 (if embedding a video link):
-VIDEO OF JONAS +[Watch this video where Jonas demonstrates creating a simple experiment](https://your-video-url.com)
16-16: Add missing comma after "Before you get started".-Before you get started see our guides on [getting started with the LaunchPad] +Before you get started, see our guides on [getting started with the LaunchPad]
🧹 Nitpick comments (4)
docs/web-console-docs/ownership-and-permissions.mdx (4)
14-14: Add comma before "so" in compound clause for clarity.-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.
28-28: Add comma before "and" to separate independent clauses.-Team level ownership is more resilient to changes and it makes it easier to manage and share assets at scale. +Team level ownership is more resilient to changes, and it makes it easier to manage and share assets at scale.
39-39: Simplify transitional phrase for more direct instruction.The phrase "To do that, just edit assets" is slightly informal. Consider using "To achieve this" or "To migrate assets" for a more direct tone.
-To do that, just edit assets that you currently own and re-assign ownership to the correct team. +To migrate these assets, edit items you currently own and reassign ownership to the correct team.
46-47: Add comma after "By default" and before "but" to separate independent clauses.-By default all platform users are members of the Global Team (feel free to rename it so it matches your company name) which represents your entire organisation but you can now also add them to their actual team in the team hierarchy. +By default, all platform users are members of the Global Team (feel free to rename it so it matches your company name), which represents your entire organisation, but you can now also add them to their actual team in the team hierarchy.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/platform-release-notes/2025/11.mdx(1 hunks)docs/web-console-docs/ownership-and-permissions.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/11.mdx
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... and give us feedback. Before you get started see our guides on [getting started with...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...he-launchpad). You can also watch this video where Jonas takes you through the proce...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...S This first release is only the first step as we have big plans for the **ABsmartl...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~41-~41: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future-proof for you. We realise th...
(MAKE_STYLE_BETTER)
[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future-proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~41-~41: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future-proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~41-~41: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
[style] ~44-~44: Consider using polite language here.
Context: ... making use of the new functionalities, let us know and if you need help for example with s...
(INSERT_PLEASE)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...ionalities, let us know and if you need help for example with some of the steps desc...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~57-~57: Consider using a different verb for a more formal wording.
Context: ...ical significance of the experiments - Fixed the issue where reporting on the impact...
(FIX_RESOLVE)
[style] ~58-~58: Consider using a different verb for a more formal wording.
Context: ...s not correct on the experiment list. - Fixed an issue so the color of the impact of ...
(FIX_RESOLVE)
[style] ~64-~64: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...ur ongoing work on performance and cost optimisation we are planning to introduce the follow...
(OXFORD_SPELLING_Z_NOT_S)
docs/web-console-docs/ownership-and-permissions.mdx
[style] ~10-~10: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...uss those changes and how you can start making use of them. ## Team structure The first bui...
(REP_MAKE_USE_OF)
[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)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...u start building your team hierarchy in ABsmartly you won't be able to start making use o...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~27-~27: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...d the item). While this is often fine, in many cases it is preferable for assets like Experi...
(IN_MANY_STYLE_CASES)
[uncategorized] ~28-~28: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...l ownership is more resilient to changes and it makes it easier to manage and share ...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~29-~29: It appears that a comma is missing.
Context: ... and share assets at scale. Because of this we introduced team level ownership for ...
(BECAUSE_OF_YOU_COMMA)
[uncategorized] ~32-~32: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...l retain their current individual owners but it won't be possible to add new ones. ...
(COMMA_COMPOUND_SENTENCE)
[style] ~39-~39: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...trics to the most relevant team in your organisation. To do that, just edit assets that you ...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~39-~39: Consider a more expressive alternative.
Context: ... relevant team in your organisation. To do that, just edit assets that you current...
(DO_ACHIEVE)
[uncategorized] ~46-~46: Did you mean: “By default,”?
Context: ...now also assign members to those teams. By default all platform users are members of the G...
(BY_DEFAULT_COMMA)
[style] ~47-~47: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...pany name) which represents your entire organisation but you can now also add them to their ...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~47-~47: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...hich represents your entire organisation but you can now also add them to their actu...
(COMMA_COMPOUND_SENTENCE)
[style] ~56-~56: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...hare all assets owned by that team. - Team Admin: Same as Team Contributor + the...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~69-~69: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... when a user is directly added to a team but it can also be implicit when inherited....
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~85-~85: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ls&Metrics` at the Global Team level but it is not recommended as it would inter...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~95-~95: It seems that a comma is missing.
Context: .... If you need help automating this step please let us know. Once the migration is done...
(IF_PLEASE_COMMA)
[uncategorized] ~102-~102: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e users to collaborate within their team but it does not allow them to share assets ...
(COMMA_COMPOUND_SENTENCE)
[style] ~103-~103: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ring or a team working on an experiment wants to allow specific users from other teams t...
(REP_WANT_TO_VB)
[typographical] ~105-~105: It seems that a comma is missing.
Context: ...without making them owners. To address this we introduced Asset level permissions (...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~108-~108: Possible missing comma found.
Context: ...tric or a template available to another team or if you want other people to be able ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~122-~122: For conciseness, try rephrasing this sentence.
Context: ...e Global Team with Can View permission. It is possible that you want all your existing metrics, goals and po...
(MAY_MIGHT_BE)
[uncategorized] ~124-~124: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: .... If this is the case, just let us know and we will run a script to automatically g...
(COMMA_COMPOUND_SENTENCE)
⏰ 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
|
|
||
| Before you get started see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). | ||
|
|
||
| You can also watch this video where Jonas takes you through the process of creating a simple experiment. |
There was a problem hiding this comment.
Add missing comma in compound sentence.
-You can also watch this video where Jonas takes you through the process of creating a simple experiment.
+You can also watch this video where Jonas takes you through the process of creating a simple experiment,Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...he-launchpad). You can also watch this video where Jonas takes you through the proce...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/platform-release-notes/2025/11.mdx around line 18, the sentence lacks a
comma before the relative clause; update "You can also watch this video where
Jonas takes you through the process of creating a simple experiment." to include
a comma after "video" so it reads "You can also watch this video, where Jonas
takes you through the process of creating a simple experiment."
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/platform-release-notes/2025/11.mdx (2)
39-42: Restructure sentences for clarity and tone.Lines 39–42 contain complex phrasing with repeated sentence structures and awkward transitions. Simplifying and adding courtesy language would improve readability:
-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. +We want to make things better and future-proof for you. We recognise that we've made significant changes, but unless you take action on the items above, nothing will change (except for Team Ownership, which is now the default but can be disabled in your settings). -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. +When you're ready to start using the new functionalities, please let us know if you need assistance with any of the steps described above.
16-20: Add missing commas for grammatical correctness.Lines 16, 18, and 20 lack commas in compound sentences:
-Before you get started see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). +Before you get started, see our guides on [getting started with the LaunchPad](/docs/LaunchPad%20Browser%20Extension/getting-started-with-the-launchpad) and [creating your first experiment](/docs/LaunchPad%20Browser%20Extension/creating-an-experiment-with-the-launchpad). -You can also watch this video where Jonas takes you through the process of creating a simple 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. +This first release is only the first step, as we have big plans for the **ABsmartly LaunchPad** in 2026.
🧹 Nitpick comments (1)
docs/platform-release-notes/2025/11.mdx (1)
60-67: Consider standardising English spelling variant.Line 62 uses British English spelling "optimisation". If the documentation targets a primarily US audience, consider changing to "optimization" for consistency:
-As part of our ongoing work on performance and cost optimisation we are planning to introduce the following data retention rules in a future update : +As part of our ongoing work on performance and cost optimization, we are planning to introduce the following data retention rules in a future update:Additionally, line 62 is missing a comma after "optimisation/optimization".
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/platform-release-notes/2025/11.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/11.mdx
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... and give us feedback. Before you get started see our guides on [getting started with...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...he-launchpad). You can also watch this video where Jonas takes you through the proce...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~20-~20: Possible missing comma found.
Context: .... This first release is only the first step as we have big plans for the **ABsmartl...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~39-~39: The wording of this phrase can be improved.
Context: ... you through those changes. We want to make things better and future-proof for you. We realise th...
(MAKE_STYLE_BETTER)
[style] ~39-~39: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...things better and future-proof for you. We realise that we introduced a lot of cha...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~39-~39: Would you like to use the Oxford spelling “realize”? The spelling ‘realise’ is also correct.
Context: ...ngs better and future-proof for you. We realise that we introduced a lot of changes but...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~39-~39: Consider using a synonym to be more concise.
Context: ... for you. We realise that we introduced a lot of changes but unless you take action on a...
(A_LOT_OF)
[style] ~42-~42: Consider using polite language here.
Context: ... making use of the new functionalities, let us know and if you need help for example with s...
(INSERT_PLEASE)
[uncategorized] ~42-~42: Possible missing comma found.
Context: ...ionalities, let us know and if you need help for example with some of the steps desc...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~55-~55: Consider using a different verb for a more formal wording.
Context: ...ical significance of the experiments - Fixed the issue where reporting on the impact...
(FIX_RESOLVE)
[style] ~56-~56: Consider using a different verb for a more formal wording.
Context: ...s not correct on the experiment list. - Fixed an issue so the color of the impact of ...
(FIX_RESOLVE)
[style] ~62-~62: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...ur ongoing work on performance and cost optimisation we are planning to introduce the follow...
(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). (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/platform-release-notes/2025/11.mdx (2)
1-10: Image import and document structure look good.
69-71: Closing section is clear and courteous.
| - Renamed the `Significance` filter to `Result` and changed it values to `Insignificant`, `Negative`, `Positive` to avoid confusion about the states and statistical significance of the experiments | ||
| - Fixed the issue where reporting on the impact of GST experiments was not correct on the experiment list. | ||
| - Fixed an issue so the color of the impact of inconclusive experiments is gray as on the experiment's overview page. |
There was a problem hiding this comment.
Fix typo and consider more formal phrasing.
Line 54 contains a grammatical error ("it values" should be "its values"), and lines 55–56 could use more formal phrasing:
-- Renamed the `Significance` filter to `Result` and changed it values to `Insignificant`, `Negative`, `Positive` to avoid confusion about the states and statistical significance of the experiments
-- Fixed the issue where reporting on the impact of GST experiments was not correct on the experiment list.
-- Fixed an issue so the color of the impact of inconclusive experiments is gray as on the experiment's overview page.
+- Renamed the `Significance` filter to `Result` and changed its values to `Insignificant`, `Negative`, `Positive` to avoid confusion about experiment states and statistical significance.
+- Resolved an issue with incorrect reporting on the impact of GST experiments in the experiment list.
+- Resolved an issue whereby the colour of the impact of inconclusive experiments now displays as grey, matching the experiment's overview page.🧰 Tools
🪛 LanguageTool
[style] ~55-~55: Consider using a different verb for a more formal wording.
Context: ...ical significance of the experiments - Fixed the issue where reporting on the impact...
(FIX_RESOLVE)
[style] ~56-~56: Consider using a different verb for a more formal wording.
Context: ...s not correct on the experiment list. - Fixed an issue so the color of the impact of ...
(FIX_RESOLVE)
🤖 Prompt for AI Agents
In docs/platform-release-notes/2025/11.mdx around lines 54 to 56, fix the typo
"it values" -> "its values" in line 54 and rewrite lines 55–56 to use more
formal, clear phrasing; e.g. state that reporting of GST experiment impacts on
the experiment list has been corrected, and that the impact color for
inconclusive experiments has been standardized to gray to match the experiment
overview page.
Summary by CodeRabbit