Skip to content

Commit 471bbe4

Browse files
committed
added analytics page
1 parent d8d73e6 commit 471bbe4

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

general/analytics.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Analytics - How we collect data
3+
---
4+
5+
## Overview
6+
7+
BetterVim provides an opt-in feature for collecting anonymous analytics data, which helps us improve the quality of our plugins and your overall experience. We use [PostHog](https://posthog.com) as our analytics platform to gather insights into how BetterVim is used, which enables us to make data-driven decisions.
8+
9+
## Why We Collect Data
10+
11+
The purpose of collecting analytics data is to better understand how our users interact with BetterVim. This information allows us to:
12+
13+
- Identify which features are most popular.
14+
- Ensure new updates improve usability and performance.
15+
- Make informed decisions when prioritizing enhancements and new features.
16+
17+
By opting in, you help us improve the product effectively based on actual usage patterns.
18+
19+
## What We Collect
20+
21+
We take privacy seriously. All data collected is anonymized and only relates to your usage of BetterVim. Here’s what we collect:
22+
23+
- **Plugin Events**: Information about how and when you use BetterVim plugins.
24+
- **Configuration Details**: General details of your Neovim configuration that are relevant to understanding compatibility and usage. For example:
25+
- Which features are enabled or disabled.
26+
- Information related to BetterVim themes (e.g., if `yugen.nvim` is in use).
27+
28+
### What We Don't Collect
29+
30+
- **Personal Information**: We do not collect your name, email, or any personally identifiable information.
31+
- **Sensitive Data**: We only collect information related to your Neovim configuration, and nothing more.
32+
33+
The data we collect is tied to a unique license identifier, which does not reveal any personal information.
34+
35+
## How to Review the Implementation
36+
37+
We believe in transparency, and we encourage users to verify what’s being collected. You can check the analytics implementation directly in your local Neovim configuration.
38+
39+
To do so, navigate to the following file in your Neovim config:
40+
```sh
41+
nvim ~/.config/nvim/lua/better-vim-core/tasks/analytics.lua
42+
```
43+
44+
This file contains the code responsible for sending analytics events to our API. You can inspect the exact data being sent, how it is anonymized, and how it is processed.
45+
46+
Feel free to reach out with any questions or concerns—your trust is important to us, and we are committed to maintaining it.
47+

mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@
7171
"group": "General",
7272
"pages": [
7373
"general/credits",
74-
"general/learning-resources"
74+
"general/learning-resources",
75+
"general/analytics"
7576
]
7677
}
7778
],

0 commit comments

Comments
 (0)