-
-
Notifications
You must be signed in to change notification settings - Fork 573
Adding Updates Section, fixing documentation error. #705
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
3f01f48
f84e002
343de6a
eedbaf6
a73ad7c
ab9badf
8fd7ffb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| { | ||
| "title": "Product Analytics", | ||
| "pages": ["bounce-rate", "replay-session"] | ||
| "pages": ["replay-session"] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| export default { | ||
| "title": "Rybbit Releases", | ||
| "description": "Release notes and changelogs for Rybbit - open-source privacy-friendly analytics", | ||
| "pages": { | ||
| "v2.0.0": { | ||
| "title": "v2.0.0", | ||
| "description": "Major update with Map/Globe rework, Journeys page redesign, and server-side script configs", | ||
| "date": "2025-10-24" | ||
| }, | ||
| "v1.6.1": { | ||
| "title": "v1.6.1", | ||
| "description": "Minor bug fixes and improvements", | ||
| "date": "2025-10" | ||
| }, | ||
| "v1.6.0": { | ||
| "title": "v1.6.0", | ||
| "description": "Added tracking outbound links, IP exclusion, custom error tracking, and UI improvements", | ||
| "date": "2025-09" | ||
| }, | ||
| "v1.5.1": { | ||
| "title": "v1.5.1", | ||
| "description": "Minor bug fixes and improvements", | ||
| "date": "2025-08" | ||
| }, | ||
| "v1.5.0": { | ||
| "title": "v1.5.0", | ||
| "description": "Added organization members support, multiple organizations, session replay improvements, and bug fixes", | ||
| "date": "2025-07" | ||
| }, | ||
| "v1.4.1": { | ||
| "title": "v1.4.1", | ||
| "description": "Minor bug fixes and improvements", | ||
| "date": "2025-07" | ||
| }, | ||
| "v1.4.0": { | ||
| "title": "v1.4.0", | ||
| "description": "Major update introducing Session Replay and Error Tracking features", | ||
| "date": "2025-06-29" | ||
| }, | ||
| "v1.3.0": { | ||
| "title": "v1.3.0", | ||
| "description": "Added API keys for tracking events and pageviews, with localhost tracking support", | ||
| "date": "2025-06" | ||
| }, | ||
| "v1.2.0": { | ||
| "title": "v1.2.0", | ||
| "description": "Added more integrations, API improvements, and blog support", | ||
| "date": "2025-05" | ||
| }, | ||
| "v1.1.0": { | ||
| "title": "v1.1.0", | ||
| "description": "Added data attribute event tracking, opt-out extension support, and subdomain tracking", | ||
| "date": "2025-04" | ||
| }, | ||
| "v1.0.0": { | ||
| "title": "v1.0.0", | ||
| "description": "First major release with Browser/OS version filtering and breaking changes for reverse proxy configs", | ||
| "date": "2025-03" | ||
| } | ||
| } | ||
| }; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: "v1.4.1" | ||
| description: "Minor bug fixes and improvements" | ||
| date: "2025-07-01" | ||
| --- | ||
|
|
||
| # v1.4.1 | ||
|
|
||
| Minor release with bug fixes and improvements. | ||
|
Comment on lines
+1
to
+9
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chainRename file to follow naming convention. The filename Rename the file to I'll verify the naming convention claim by checking the actual release note files in the repository. Length of output: 352 Rename file to follow naming convention. The filename Rename 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: "v1.0.0" | ||
| description: "First major release with Browser/OS version filtering and breaking changes for reverse proxy configs" | ||
| date: "2025-03-01" | ||
| --- | ||
|
|
||
| # v1.0.0 | ||
|
|
||
| ## Migration | ||
|
|
||
| There are breaking changes if you used a custom reverse proxy to host Rybbit - We have removed the `/api` rewrite and you will need to modify your reverse proxy config | ||
|
|
||
| ## Key Features | ||
|
|
||
| ### Browser Versions | ||
|
|
||
| Filter analytics data by specific browser versions to understand user distribution across different browser releases. | ||
|
|
||
| ### Operation System Versions | ||
|
|
||
| Filter analytics data by operating system versions to gain insights into your user's platform preferences. | ||
|
Comment on lines
+11
to
+21
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix typos and lightly polish wording in this update A few small language issues are worth correcting for clarity and polish:
Example patch: -There are breaking changes if you used a custom reverse proxy to host Rybbit - We have removed the `/api` rewrite and you will need to modify your reverse proxy config
+There are breaking changes if you use a custom reverse proxy to host Rybbit. We have removed the `/api` rewrite, so you will need to update your reverse proxy configuration.-### Operation System Versions
+### Operating System Versions-Filter analytics data by operating system versions to gain insights into your user's platform preferences.
+Filter analytics data by operating system versions to gain insights into your users' platform preferences.Also consider expanding the truncated word in the line ending with Also applies to: 19-21, 32-32 🤖 Prompt for AI Agents |
||
|
|
||
| ## What's Changed | ||
|
|
||
| - Free by [@goldflag](https://github.com/goldflag) in [#313](https://github.com/rybbit-io/rybbit/pull/313) | ||
| - fix og by [@goldflag](https://github.com/goldflag) in [#320](https://github.com/rybbit-io/rybbit/pull/320) | ||
| - Update self-hosting-advanced.mdx by [@smileBeda](https://github.com/smileBeda) in [#323](https://github.com/rybbit-io/rybbit/pull/323) | ||
| - fix: healthcheck log level silent by [@nktnet1](https://github.com/nktnet1) in [#317](https://github.com/rybbit-io/rybbit/pull/317) | ||
| - feat(filters): add support for browser and OS version filters by [@goldflag](https://github.com/goldflag) in [#326](https://github.com/rybbit-io/rybbit/pull/326) | ||
| - blog by [@goldflag](https://github.com/goldflag) in [#269](https://github.com/rybbit-io/rybbit/pull/269) | ||
| - doc: add optional section on rewriting the tracking script. by [@rexwangcc](https://github.com/rexwangcc) in [#328](https://github.com/rybbit-io/rybbit/pull/328) | ||
| - feat(api): implement organization-specific site retrieval and subscri… by [@goldflag](https://github.com/goldflag) in [#333](https://github.com/rybbit-io/rybbit/pull/333) | ||
| - docs: add mention of cloudflare specific issues by [@mezotv](https://github.com/mezotv) in [#337](https://github.com/rybbit-io/rybbit/pull/337) | ||
| - remove reverse proxy rewrite by [@goldflag](https://github.com/goldflag) in [#340](https://github.com/rybbit-io/rybbit/pull/340) | ||
|
|
||
| ## New Contributors | ||
|
|
||
| - [@rexwangcc](https://github.com/rexwangcc) made their first contribution in [#328](https://github.com/rybbit-io/rybbit/pull/328) | ||
| - [@mezotv](https://github.com/mezotv) made their first contribution in [#337](https://github.com/rybbit-io/rybbit/pull/337) | ||
|
|
||
| **Full Changelog**: [v0.4.2...v1.0.0](https://github.com/rybbit-io/rybbit/compare/v0.4.2...v1.0.0) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: "v1.1.0" | ||
| description: "Added data attribute event tracking, opt-out extension support, and subdomain tracking" | ||
| date: "2025-04-01" | ||
| --- | ||
|
|
||
| # v1.1.0 | ||
|
|
||
| ## Key Features | ||
|
|
||
| 1. Track events using [data attributes](https://www.rybbit.io/docs/track-events#using-data-attributes) | ||
| 2. Add support for Rybbit [opt-out extension](https://chromewebstore.google.com/detail/rybbit-opt-out/gofnfdfidbkpellionhpmkejgaajieoo). Thank you [@davidfiala](https://github.com/davidfiala) | ||
| 3. Added support for tracking subdomains within the same site | ||
|
|
||
| ## What's Changed | ||
|
|
||
| - Debug pg by [@goldflag](https://github.com/goldflag) in [#352](https://github.com/rybbit-io/rybbit/pull/352) | ||
| - Apple debug by [@goldflag](https://github.com/goldflag) in [#354](https://github.com/rybbit-io/rybbit/pull/354) | ||
| - fix(healthcheck): v1.0.0 now requires /api prefix in base path by [@nktnet1](https://github.com/nktnet1) in [#355](https://github.com/rybbit-io/rybbit/pull/355) | ||
| - Update README.md by [@smileBeda](https://github.com/smileBeda) in [#236](https://github.com/rybbit-io/rybbit/pull/236) | ||
| - Create CONTRIBUTE.md by [@smileBeda](https://github.com/smileBeda) in [#235](https://github.com/rybbit-io/rybbit/pull/235) | ||
| - Create SECURITY.md by [@smileBeda](https://github.com/smileBeda) in [#234](https://github.com/rybbit-io/rybbit/pull/234) | ||
| - support rybbit opt-out extension and add explicit terser packing script to package.json by [@davidfiala](https://github.com/davidfiala) in [#363](https://github.com/rybbit-io/rybbit/pull/363) | ||
| - Comparison by [@goldflag](https://github.com/goldflag) in [#369](https://github.com/rybbit-io/rybbit/pull/369) | ||
| - Enhance event tracking capabilities and update documentation by [@goldflag](https://github.com/goldflag) in [#374](https://github.com/rybbit-io/rybbit/pull/374) | ||
| - Enhance domain normalization and tracking validation by [@goldflag](https://github.com/goldflag) in [#376](https://github.com/rybbit-io/rybbit/pull/376) | ||
|
|
||
| ## New Contributors | ||
|
|
||
| - [@davidfiala](https://github.com/davidfiala) made their first contribution in [#363](https://github.com/rybbit-io/rybbit/pull/363) | ||
|
|
||
| **Full Changelog**: [v1.0.0...v1.1.0](https://github.com/rybbit-io/rybbit/compare/v1.0.0...v1.1.0) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: "v1.2.0" | ||
| description: "Added more integrations, API improvements, and blog support" | ||
| date: "2025-05-01" | ||
| --- | ||
|
|
||
| # v1.2.0 | ||
|
|
||
| ## What's Changed | ||
|
|
||
| - Add more integrations by [@goldflag](https://github.com/goldflag) in [#377](https://github.com/rybbit-io/rybbit/pull/377) | ||
| - Fix docs by [@goldflag](https://github.com/goldflag) in [#379](https://github.com/rybbit-io/rybbit/pull/379) | ||
| - shared package by [@goldflag](https://github.com/goldflag) in [#380](https://github.com/rybbit-io/rybbit/pull/380) | ||
| - Enhance API utility functions to use axios for HTTP requests by [@goldflag](https://github.com/goldflag) in [#387](https://github.com/rybbit-io/rybbit/pull/387) | ||
| - fix optout- original commit messed up the && vs || operator, meaning v1.0.0 and v1.1.0 require both to opt out. apologies this was missed by [@davidfiala](https://github.com/davidfiala) in [#389](https://github.com/rybbit-io/rybbit/pull/389) | ||
| - adding blog by [@JMeng1](https://github.com/JMeng1) in [#385](https://github.com/rybbit-io/rybbit/pull/385) | ||
| - Blog post - adding pictures by [@JMeng1](https://github.com/JMeng1) in [#393](https://github.com/rybbit-io/rybbit/pull/393) | ||
| - Remove deprecated analytics hooks and refactor API structure for funn… by [@goldflag](https://github.com/goldflag) in [#394](https://github.com/rybbit-io/rybbit/pull/394) | ||
| - Refactor analytics API endpoints to utilize `FilterParams` for improv… by [@goldflag](https://github.com/goldflag) in [#396](https://github.com/rybbit-io/rybbit/pull/396) | ||
| - Refactor analytics time mode handling to support past minutes by [@goldflag](https://github.com/goldflag) in [#400](https://github.com/rybbit-io/rybbit/pull/400) | ||
| - Refactor package management and API functions for improved clarity an… by [@goldflag](https://github.com/goldflag) in [#401](https://github.com/rybbit-io/rybbit/pull/401) | ||
| - Add SVG logos to assets — resolves [#406](https://github.com/rybbit-io/rybbit/issues/406) by [@poliroid](https://github.com/poliroid) in [#408](https://github.com/rybbit-io/rybbit/pull/408) | ||
| - build script by [@goldflag](https://github.com/goldflag) in [#410](https://github.com/rybbit-io/rybbit/pull/410) | ||
|
|
||
| ## New Contributors | ||
|
|
||
| - [@JMeng1](https://github.com/JMeng1) made their first contribution in [#385](https://github.com/rybbit-io/rybbit/pull/385) | ||
| - [@poliroid](https://github.com/poliroid) made their first contribution in [#408](https://github.com/rybbit-io/rybbit/pull/408) | ||
|
|
||
| **Full Changelog**: [v1.1.0...v1.2.0](https://github.com/rybbit-io/rybbit/compare/v1.1.0...v1.2.0) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| title: "v1.3.0" | ||
| description: "Added API keys for tracking events and pageviews, with localhost tracking support" | ||
| date: "2025-06-01" | ||
| --- | ||
|
|
||
| # v1.3.0 | ||
|
|
||
| ## Key Features | ||
|
|
||
| - Added API keys for tracking events/pageviews via [http endpoint](https://www.rybbit.io/docs/api) | ||
| - API keys can also be used for tracking events on [localhost](https://www.rybbit.io/docs/localhost-tracking) | ||
| - Bug fixes | ||
|
|
||
| **Full Changelog**: [v1.2.0...v1.3.0](https://github.com/rybbit-io/rybbit/compare/v1.2.0...v1.3.0) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: "v1.4.0" | ||
| description: "Major update introducing Session Replay and Error Tracking features" | ||
| date: "2025-06-29" | ||
| --- | ||
|
|
||
| # v1.4.0 | ||
|
|
||
| **Note**: You may have to run `git stash` before running the `./update` script since I made some changes to it. | ||
|
|
||
| ## Key Features | ||
|
|
||
| ### Session Replay | ||
|
|
||
| Watch real user sessions to understand their behavior and identify pain points. | ||
|
|
||
| ### Error Tracking | ||
|
|
||
| Track and monitor errors that occur on your website, with detailed information about each error. | ||
|
|
||
| ## Commit Log | ||
|
|
||
| - Add error tracking feature and update documentation by [@goldflag](https://github.com/goldflag) in [#418](https://github.com/rybbit-io/rybbit/pull/418) | ||
| - Implement session replay feature and enhance analytics script by [@goldflag](https://github.com/goldflag) in [#424](https://github.com/rybbit-io/rybbit/pull/424) | ||
| - Test by [@goldflag](https://github.com/goldflag) in [#429](https://github.com/rybbit-io/rybbit/pull/429) | ||
| - Update viewport dimensions to use screen size for tracking data by [@goldflag](https://github.com/goldflag) in [#431](https://github.com/rybbit-io/rybbit/pull/431) | ||
| - Refactor Docker configuration and update Caddyfile for Rybbit services by [@goldflag](https://github.com/goldflag) in [#411](https://github.com/rybbit-io/rybbit/pull/411) | ||
| - Fix rrweb by [@goldflag](https://github.com/goldflag) in [#434](https://github.com/rybbit-io/rybbit/pull/434) | ||
|
|
||
| **Full Changelog**: [v1.3.0...v1.4.0](https://github.com/rybbit-io/rybbit/compare/v1.3.0...v1.4.0) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Standardize date formats across all version entries.
The date formats are inconsistent—some entries use full ISO dates (e.g.,
"2025-10-24","2025-06-29") while others use partial year-month formats (e.g.,"2025-10","2025-09"). Additionally, v1.2.0 has"2025-05"here but"2025-05-01"in the corresponding MDX file.Standardize all dates to full ISO format (YYYY-MM-DD) for consistency and reliable date parsing.
Apply this diff to standardize the date formats:
"v1.6.1": { "title": "v1.6.1", "description": "Minor bug fixes and improvements", - "date": "2025-10" + "date": "2025-10-01" }, "v1.6.0": { "title": "v1.6.0", "description": "Added tracking outbound links, IP exclusion, custom error tracking, and UI improvements", - "date": "2025-09" + "date": "2025-09-01" }, "v1.5.1": { "title": "v1.5.1", "description": "Minor bug fixes and improvements", - "date": "2025-08" + "date": "2025-08-01" }, "v1.5.0": { "title": "v1.5.0", "description": "Added organization members support, multiple organizations, session replay improvements, and bug fixes", - "date": "2025-07" + "date": "2025-07-01" }, "v1.4.1": { "title": "v1.4.1", "description": "Minor bug fixes and improvements", - "date": "2025-07" + "date": "2025-07-01" }, "v1.3.0": { "title": "v1.3.0", "description": "Added API keys for tracking events and pageviews, with localhost tracking support", - "date": "2025-06" + "date": "2025-06-01" }, "v1.2.0": { "title": "v1.2.0", "description": "Added more integrations, API improvements, and blog support", - "date": "2025-05" + "date": "2025-05-01" }, "v1.1.0": { "title": "v1.1.0", "description": "Added data attribute event tracking, opt-out extension support, and subdomain tracking", - "date": "2025-04" + "date": "2025-04-01" }, "v1.0.0": { "title": "v1.0.0", "description": "First major release with Browser/OS version filtering and breaking changes for reverse proxy configs", - "date": "2025-03" + "date": "2025-03-01" }📝 Committable suggestion
🤖 Prompt for AI Agents