Skip to content

Conversation

@chris-absmartly
Copy link
Collaborator

@chris-absmartly chris-absmartly commented Jul 7, 2025

Added July release notes + slightly update the design of previous notes

Summary by CodeRabbit

  • Documentation
    • Improved readability and structure of multiple release notes by adding section headers and horizontal rule dividers.
    • Added a new release note for July 2025, highlighting a built-in notification system, "Impact per Day" metrics, and updates to the Metrics Overview tab.
    • Corrected terminology in the experiment results documentation, changing "Efficiency Boundary" to "Efficacy Boundary".
    • Fixed a typographical error in the events documentation.

@netlify
Copy link

netlify bot commented Jul 7, 2025

Deploy Preview for absmartly-docs ready!

Name Link
🔨 Latest commit 937465a
🔍 Latest deploy log https://app.netlify.com/projects/absmartly-docs/deploys/686b942eb7da96000855f6ab
😎 Deploy Preview https://deploy-preview-232--absmartly-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link

coderabbitai bot commented Jul 7, 2025

Walkthrough

The updates primarily focus on improving the structure and readability of several release notes documents for the platform, spanning February to July 2025. Changes include the addition of horizontal rule separators between major sections and the introduction of "Overview" headings at the start of several documents. A new release note for July 2025 details platform updates such as a notification system, impact per day estimates, and enhancements to the Metrics Overview tab. Additionally, minor corrections were made in the documentation, including a terminology fix from "Efficiency Boundary" to "Efficacy Boundary" and a spelling correction from "seleting" to "selecting".

Poem

Hopping through notes, a bunny’s delight,
With lines and headers, sections set right.
July brings new features, so shiny and bright,
While spelling and terms now hop into sight.
🐇—With every divider and overview clear,
The docs are much neater, let’s all give a cheer!

(A rabbit’s work is never quite done,
But organising docs sure is fun!)


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (1)
docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx (1)

94-101: Boundary label now inconsistent – update the earlier bullet too.

Line 94 still says “Efficiency Boundary (Green Region)” while line 100 correctly switches to “Efficacy Boundary”. Having both terms in the same section is confusing.

- **Efficiency Boundary (Green Region)**: The upper boundary. If the Z-Score trajectory crosses this boundary, the variant shows a statistically significant improvement, and the experiment can be stopped early for success.
+ **Efficacy Boundary (Green Region)**: The upper boundary. If the Z-Score trajectory crosses this boundary, the variant shows a statistically significant improvement, and the experiment can be stopped early for success.
🧹 Nitpick comments (6)
docs/platform-release-notes/2025/07.mdx (1)

9-14: Add missing hyphens in “up-to-date”.

Minor wording nitpick for grammatical correctness.

- notification system ensures you're always up to date with what's happening on the platform.
+ notification system ensures you're always up-to-date with what's happening on the platform.
docs/platform-release-notes/2025/04.mdx (1)

6-6: Comma needed after dependent clause.

For smoother reading add a comma after “from you”.

-...feedback we received from you so keep them coming.
+...feedback we received from you, so keep them coming.
docs/platform-release-notes/2025/06.mdx (1)

3-3: Strip trailing spaces from the heading
Two trailing spaces after “Overview” are unnecessary in a heading and may violate Markdown-lint rules. Consider removing them to keep headings consistent across the docs.

-## Overview··
+## Overview
docs/platform-release-notes/2025/05.mdx (1)

3-3: Remove superfluous spaces in the heading
The double space after “Overview” is not required and can trigger style-lint warnings.

-## Overview··
+## Overview
docs/platform-release-notes/2025/03.mdx (2)

3-3: Trim trailing spaces in the heading
Trailing spaces after “Overview” are redundant and could fail Markdown linters.

-## Overview··
+## Overview

4-4: Minor tense tweak for clarity
“This release focuses mainly on our reports by improving…” reads well, but “by improving” can be clearer as “through improvements to”. Up to you—purely stylistic.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22a9842 and f1c4049.

📒 Files selected for processing (8)
  • docs/platform-release-notes/2025/02.mdx (3 hunks)
  • docs/platform-release-notes/2025/03.mdx (4 hunks)
  • docs/platform-release-notes/2025/04.mdx (2 hunks)
  • docs/platform-release-notes/2025/05.mdx (1 hunks)
  • docs/platform-release-notes/2025/06.mdx (3 hunks)
  • docs/platform-release-notes/2025/07.mdx (1 hunks)
  • docs/web-console-docs/Interpreting-metrics-in-experiment-results.mdx (1 hunks)
  • docs/web-console-docs/events.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/05.mdx

[uncategorized] ~11-~11: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ... - Early stop vs Early full-on: The Experiments not completed graph now shows the break...

(AI_HYDRA_LEO_APOSTROPHE_S_XS)


[typographical] ~17-~17: It appears that a comma is missing.
Context: ...yone to make quality decisions. In this release we added GST data to the metric's table...

(DURING_THAT_TIME_COMMA)


[typographical] ~20-~20: The word ‘What’ starts a question. Add a question mark (“?”) at the end of the sentence.
Context: ...artly.com](mailto:[email protected]). --- ## Feedback and Next Steps As al...

(WP_APOSTROPHE_VERB_QUESTION_MARK)

docs/platform-release-notes/2025/04.mdx

[duplication] ~3-~3: Possible typo: you repeated a word.
Context: # April 2025 ## Overview Overview In this new release we mainly focused ...

(ENGLISH_WORD_REPEAT_RULE)


[typographical] ~6-~6: It appears that a comma is missing.
Context: ...25 ## Overview Overview In this new release we mainly focused on improvement to the...

(DURING_THAT_TIME_COMMA)


[uncategorized] ~6-~6: Possible missing comma found.
Context: ...are driven by feedback we received from you so keep them coming. Here are some of t...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~22-~22: Possible missing comma found.
Context: ... --- ## Decisions Report Earlier this month we launched the new [Decisions Reports ...

(AI_HYDRA_LEO_MISSING_COMMA)


[typographical] ~22-~22: It appears that a comma is missing.
Context: ...t-reports/#decisions-overview). In this release we are introducing a few improvements t...

(DURING_THAT_TIME_COMMA)

docs/platform-release-notes/2025/07.mdx

[uncategorized] ~10-~10: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...tification system ensures you're always up to date with what's happening on the platform. ...

(UP_TO_DATE_HYPHEN)


[style] ~36-~36: Consider using polite language here.
Context: ...hen reviewing experiment results. --- Let us know if you have any questions or if you wou...

(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: Yarn Build
  • GitHub Check: Redirect rules - absmartly-docs
  • GitHub Check: Header rules - absmartly-docs
  • GitHub Check: Pages changed - absmartly-docs
🔇 Additional comments (5)
docs/web-console-docs/events.mdx (1)

14-15: Spelling fix looks good.

The corrected “selecting” eliminates the previous typo without altering meaning.

docs/platform-release-notes/2025/02.mdx (1)

8-9: Section dividers added – no issues.

The horizontal rules cleanly separate sections and improve readability.

docs/platform-release-notes/2025/06.mdx (1)

6-6: 👍 Consistent use of horizontal rules
Adding --- separators improves visual scanning and matches the pattern adopted in earlier months. No issues spotted.

Also applies to: 18-18, 37-37, 46-46, 52-52

docs/platform-release-notes/2025/05.mdx (1)

6-6: Good call on visual separators
The added --- lines bring May’s notes in line with the newer layout. Looks correct.

Also applies to: 13-13, 22-22

docs/platform-release-notes/2025/03.mdx (1)

9-9: Section breaks look excellent
The inserted --- separators make the document much easier to scan. No concerns.

Also applies to: 29-29, 51-51, 70-70

# April 2025

## Overview
Overview
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Overview

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/platform-release-notes/2025/04.mdx (1)

3-3: Trim the trailing spaces in the heading.

The two spaces after “Overview” serve no semantic purpose inside a Markdown heading and may result in unexpected rendering or linter noise.

-## Overview  
+## Overview
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f1c4049 and 937465a.

📒 Files selected for processing (1)
  • docs/platform-release-notes/2025/04.mdx (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/platform-release-notes/2025/04.mdx

[typographical] ~5-~5: It appears that a comma is missing.
Context: ... April 2025 ## Overview In this new release we mainly focused on improvement to the...

(DURING_THAT_TIME_COMMA)


[uncategorized] ~5-~5: Possible missing comma found.
Context: ...are driven by feedback we received from you so keep them coming. Here are some of t...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~21-~21: Possible missing comma found.
Context: ... --- ## Decisions Report Earlier this month we launched the new [Decisions Reports ...

(AI_HYDRA_LEO_MISSING_COMMA)


[typographical] ~21-~21: It appears that a comma is missing.
Context: ...t-reports/#decisions-overview). In this release we are introducing a few improvements t...

(DURING_THAT_TIME_COMMA)

⏰ 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 (3)
docs/platform-release-notes/2025/04.mdx (3)

7-8: Section divider looks good.

The horizontal rule cleanly separates the overview from the next section.


17-18: Consistent use of horizontal rules confirmed.

Maintains the same visual structure as earlier sections.


26-27: Structure consistency acknowledged.

Third divider continues the established pattern – no issues spotted.

@calthejuggler calthejuggler merged commit 37be503 into development Jul 7, 2025
6 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 2, 2025
@coderabbitai coderabbitai bot mentioned this pull request Oct 7, 2025
chris-absmartly added a commit that referenced this pull request Nov 10, 2025
@coderabbitai coderabbitai bot mentioned this pull request Nov 14, 2025
joalves pushed a commit that referenced this pull request Jan 12, 2026
joalves pushed a commit that referenced this pull request Jan 12, 2026
@coderabbitai coderabbitai bot mentioned this pull request Jan 12, 2026
joalves pushed a commit that referenced this pull request Jan 12, 2026
joalves pushed a commit that referenced this pull request Jan 13, 2026
joalves pushed a commit that referenced this pull request Jan 13, 2026
joalves added a commit that referenced this pull request Jan 15, 2026
…tes (clean rebase) (#243)

* Added information about sampling of visitors in performance graph

* Fixed image

* added new image path

* add new experiment create article

* feat: add release notes section

* 2025 july release notes (#232)

* added managing team entry in wiki

* Fixed a few typos

* and more typos

* change file name to refect the H1

* Initial version, no screenshot

* typo

* added images

* typo and image links

* add hero image

* new install guide for launchPad

* Fix LaunchPad installation docs and add DOM Changes SDK plugin section

- 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

* Update Chrome Web Store screenshot to landscape resolution (1920x1080)

* Add direct link to Chrome Web Store and update screenshot

- Add clickable link to extension page at the top of installation section
- Replace screenshot with improved Chrome Web Store image

* Added setup guide for Chrome Extension

* fix path to image folder

* I fixed the path in the wrong file

* New events documentation

* Added missing images

* Fixed typocs and removed all files + images

* Added Applications and Units pages in Configuration

* Fix broekn paths to settings

* Added Teams & Users

* more broken links

* and again

* add new KB folders for metric, experiments and FF

* broken link to metric pages

* added goals & metrics pages

* fixed broken links

* fix typo

* Merged metric groups into overview

* added Metrics overview

* added some of the metrics type

* added metric metadata

* Fixed path to settings

* Attempt to explain goal ownership and permissions

* one more broken link

* again

* Added outliers and metrics filters

* fixed some formating issues

* added goal relations draft

* added goal relations images + alert thresholds

* added formating information

* added image to support formatting

* Outliers are capped and not excluded

* added versioning info

* added metrics ownership and versionsioning info

* added new metric type pages

* move experiments pages to dedicated folder. I expect many broken links

* fixed broken links

* added experiment overview

* added GT and Fixed Horizon info

* added oermissions

* added Launchpad info

* broken link to images

* Added Users, Teams & Roles entries

* added team info

* reordered the menu

* updated navigation

* fix issue with index

* create API & SDK folder

* even better structure

* broken links to SSO

* fix link to SDK documentation

* Some more broken links to sdk doc

* move auto-generated content to the correct place

* fix links to SDK-API

* and again

* add get started guide

* workding change get started

* try home page redirect

* that did not work

* again

* and that?

* use relative path

* added get started guide

* added link to SDKs doc in header

* added links to get started guide

* typo in link

* link to SDK

* stil ldoes not work

* rename landing to overview

* added more link to get started guide

* added teams documentation

* some typo in Team

* added glossary

* A and B in glossary

* new C entries

* try better formatting

* E and F

* broken anchor

* forgot another anchor

* broken external link

* G and H

* M

* N, O

* Added some more entried to the glossary

* fixed some typo

* Added missing images

* P, Q, R, S

* done

* typos

* more typos

* and more

* feat: add hybrid redirect system for URL structure changes

Implements server-side (Netlify) and client-side redirects to handle
URL structure changes in new-kb branch. Server redirects handle path
changes, client script handles anchor/hash updates.

* small typo

* fix: add trailing slashes and missing anchor redirects

- Add trailing slashes to server redirects to match Docusaurus URL normalization
- Strip trailing slash from pathname in client-side redirect check
- Add missing anchor redirects for creating-a-feature (application, targeting-audiences)

* debug: add console logging to anchor redirects

Add debug logging to understand why client-side anchor redirects aren't working

* feat: add comprehensive anchor redirects for old and new paths

- Add anchor redirects for OLD page paths (pre-server redirect)
- Keep anchor redirects for NEW page paths (post-server redirect)
- Remove debug console logging
- Verified all redirects work locally with test-anchor-redirects-local.js

* fix: remove duplicate _category_ copy.json files

* fix: address all 23 PR review comments

- Fix duplicate horizontal rules in release notes
- Remove empty lines and fix formatting
- Improve JavaScript code blocks (const, camelCase, strict equality)
- Fix JSON code block language tags (ts -> json)
- Fix content wording (British -> American English, list formatting)
- Convert anchorRedirects.js to TypeScript with proper types
- Improve index.tsx to use Docusaurus Redirect component
- Remove empty 'Special attributes' section
- Generate API documentation for build success
- Update .gitignore for Claude files and openapi backup

All 23 review comments addressed. Build passes successfully.

Fixes: #243

* fix: correct GST experiment redirect and optimize anchor redirects

- Fix GST redirect: setting-up-a-fixed-horizon-experiment → setting-up-a-gst-experiment
- Remove unnecessary anchor redirects that browser preserves automatically (7 removed)
- Only keep anchor redirects for actual transformations (9 remaining)

Browser automatically preserves unchanged anchors during 302 redirects per HTTP spec.

Ref: PR feedback about redirect verification

* test: update redirect test script with all 28 URL mappings

- Add all 7 server-side redirects from static/_redirects
- Add all 9 JS anchor transforms from anchorRedirects.ts
- Add 8 browser anchor preservation tests
- Add 4 new-path JS transform tests
- Fix GST redirect path (corrected in 666c96c)
- Group results by redirect type for better reporting
- Add comprehensive troubleshooting guidance

Total: 28 comprehensive redirect tests covering all documented URL changes.

* test: add comprehensive URL testing script for all ~223 URLs

- Test all ~201 documentation pages load successfully
- Test all 23 redirects (server, browser-preserved, JS transforms)
- Visual progress indicator and grouped reporting
- Comprehensive summary with troubleshooting tips

Usage: node test-all-urls.js https://deploy-preview-243--absmartly-docs.netlify.app

* chore: add openapi_console_bk to gitignore

Prevents committing backup files with secrets in examples/storage_configs.yaml

* feat: add comprehensive redirects for all 23 renamed MDX files

- Add 18 missing redirects to static/_redirects (now 25 total, was 7)
- SDK Documentation: 10 redirects
- Examples: 1 redirect
- Configuration: 1 redirect
- Users/Teams/Permissions: 2 redirects
- Experiments: 8 redirects (including corrected GST redirect)
- Feature Flags: 1 redirect
- Update test script to test all 48 redirect scenarios
- Test script now covers ~136 total URLs (88 pages + 48 redirects)

Ensures all renamed pages have proper redirects configured.

* feat: add --only-failed flag to URL testing script

- Add --only-failed flag to retry only previously failed pages
- Avoids rate limiting by not retesting all pages
- Stores list of 37 previously failed pages from first run
- Updated help text with flag documentation

Usage: node test-all-urls.js <URL> --only-failed

* fix: address final 2 PR review comments

- Fix 'Non engineers' → 'Non-engineers' (add hyphen and 'can')
- Remove unnecessary '(for SPAs like Docusaurus)' comment

All 25 review comments now addressed.

---------

Co-authored-by: christophe perrin <[email protected]>
Co-authored-by: Cal Courtney <[email protected]>
Co-authored-by: Jonas Alves <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants