Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Refactor Card component styles and update documentation headings

Bill Yang87d6916852fc
diff --git a/client/src/components/ui/card.tsx b/client/src/components/ui/card.tsx
index bc00a7d76..09ae794e9 100644
--- a/client/src/components/ui/card.tsx
+++ b/client/src/components/ui/card.tsx
@@ -13,7 +13,7 @@ const Card = React.forwardRef<
<div
ref={ref}
className={cn(
- "relative rounded-lg border border-neutral-200 bg-white text-neutral-950 dark:border-neutral-850 dark:bg-neutral-900 dark:text-neutral-50 overflow-hidden transition-all duration-300 animate-in fade-in-0 zoom-in-95",
+ "relative rounded-lg border border-neutral-200 bg-white text-neutral-950 dark:border-neutral-850 dark:bg-neutral-900 dark:text-neutral-50 overflow-hidden transition-all duration-300 ",
className
)}
{...props}
@@ -81,10 +81,7 @@ const CardContent = React.forwardRef<
>(({ className, ...props }, ref) => (
<div
ref={ref}
- className={cn(
- "relative p-4 pt-0 transition-all duration-300 animate-in fade-in-0 zoom-in-95",
- className
- )}
+ className={cn("relative p-4 pt-0 transition-all duration-300 ", className)}
{...props}
/>
));
diff --git a/docs/public/settings.jpg b/docs/public/settings.jpg
new file mode 100644
index 000000000..5666f6a26
Binary files /dev/null and b/docs/public/settings.jpg differ
diff --git a/docs/src/app/showcase/(overview)/page.jsx b/docs/src/app/showcase/(overview)/page.jsx
deleted file mode 100644
index 790402802..000000000
--- a/docs/src/app/showcase/(overview)/page.jsx
+++ /dev/null
@@ -1,14 +0,0 @@
-export default function Page() {
- return (
- <h1
- style={{
- textAlign: 'center',
- fontSize: 64,
- margin: '25vh 0',
- fontWeight: 'bold'
- }}
- >
- Showcase
- </h1>
- )
-}
diff --git a/docs/src/content/_meta.js b/docs/src/content/_meta.js
index 65af6447d..10515918e 100644
--- a/docs/src/content/_meta.js
+++ b/docs/src/content/_meta.js
@@ -1,6 +1,29 @@
export default {
index: "",
+ _3: {
+ type: "separator",
+ title: "Tracking",
+ },
tracker: "",
"track-events": "",
+ _4: {
+ type: "separator",
+ title: "Self-hosting",
+ },
"self-hosting": "",
+ "self-hosting-upgrading": "",
+ _5: {
+ type: "separator",
+ title: "Settings",
+ },
+ "adding-users": "",
+ "public-site": "",
+ "enhanced-privacy": "",
+ "changing-domains": "",
+ "deleting-sites": "",
+ _6: {
+ type: "separator",
+ title: "Other",
+ },
+ definitions: "",
};
diff --git a/docs/src/content/adding-users.mdx b/docs/src/content/adding-users.mdx
index 118341d2f..93eb64453 100644
--- a/docs/src/content/adding-users.mdx
+++ b/docs/src/content/adding-users.mdx
@@ -1,7 +1,7 @@
import { Steps } from 'nextra/components'
import { Callout } from 'nextra/components'
-# Adding Users to your Organization
+# Adding Users
Both the cloud and self-hosted versions of Rybbit support adding users to your organization.
diff --git a/docs/src/content/changing-domains.mdx b/docs/src/content/changing-domains.mdx
new file mode 100644
index 000000000..73631cd91
--- /dev/null
+++ b/docs/src/content/changing-domains.mdx
@@ -0,0 +1,14 @@
+import Image from "next/image";
+
+
+# Changing domains
+
+You can update the domain of your site by going to the settings page on your site's Rybbit dashboard.
+
+Changing domains will not affect any existing data.
+
+Currently we only support one domain per site.
+
+<br/>
+<Image src="/settings.jpg" alt="Public Site" width={500} height={500} />
+
diff --git a/docs/src/content/deleting-sites.mdx b/docs/src/content/deleting-sites.mdx
new file mode 100644
index 000000000..2a0e27ae2
--- /dev/null
+++ b/docs/src/content/deleting-sites.mdx
@@ -0,0 +1,10 @@
+
+import Image from "next/image";
+
+# Deleting sites
+
+You can delete a site by going to the settings page on the site's dashboard and clicking the "Delete Site" button. This will delete all data associated with the site.
+
+<br/>
+<Image src="/settings.jpg" alt="Public Site" width={500} height={500} />
+
diff --git a/docs/src/content/enhanced-privacy.mdx b/docs/src/content/enhanced-privacy.mdx
new file mode 100644
index 000000000..f8d56d686
--- /dev/null
+++ b/docs/src/content/enhanced-privacy.mdx
@@ -0,0 +1,25 @@
+import Image from "next/image";
+import { Callout } from 'nextra/components'
+
+# Enhanced Privacy
+
+<Callout type="info">
+ If strict GDPR/CCPA compliance is not important to you, leave this option disabled as it makes some parts of the analytics less accurate.
+</Callout>
+
+Rybbit stores user IDs as a hashed combination of IP + user agent. Doing this allows us to identify users across many sessions on the same device, but can be seen as storing personally identifiable data under GDPR.
+
+You can enable enhanced privacy by going to the settings page of your website dashboard and enabling the "User ID Salting" option.
+
+When you turn this one, Rybbit will forget about unique users every day. If a user visits your site 10 times in one day, Rybbit will count that as one user with 10 sessions. But if he visits once a day for 10 days, he will be seen as a new user every day.
+
+<br/>
+<Image src="/settings.jpg" alt="Public Site" width={500} height={500} />
+
+### Downsides of enabling user ID salting:
+
+- You will no longer see user session history beyond 24 hours.
+- Unique user count over a period longer than 24 hours will be inflated.
+- The user retention page will effectively be useless.
+
+
diff --git a/docs/src/content/public-site.mdx b/docs/src/content/public-site.mdx
new file mode 100644
index 000000000..1dee1ecf8
--- /dev/null
+++ b/docs/src/content/public-site.mdx
@@ -0,0 +1,11 @@
+import Image from "next/image";
+
+# Make you analytics public
+
+You can make your analytics public by going to the settings page and enabling the "Public Analytics" option. You can then share the page link with anyone you want.
+
+- External viewers will not be able to edit any of your settings or add/remove/edit any existing reports, funnels, or goals.
+- Your other websites will not be affected.
+
+<br/>
+<Image src="/settings.jpg" alt="Public Site" width={500} height={500} />
diff --git a/docs/src/content/self-hosting-upgrading.mdx b/docs/src/content/self-hosting-upgrading.mdx
new file mode 100644
index 000000000..2b52feb05
--- /dev/null
+++ b/docs/src/content/self-hosting-upgrading.mdx
@@ -0,0 +1,20 @@
+import { Steps } from 'nextra/components'
+
+
+# Upgrading
+
+To upgrade your self-hosted Rybbit instance to the latest version:
+
+<Steps>
+### 1. Pull the latest changes from the repository:
+```bash
+git pull
+```
+
+### 2. Rebuild and restart your Docker containers:
+```bash
+docker compose up -d --build
+```
+</Steps>
+
+We add great features to Rybbit all the time, so upgrade often to get your hands on the latest and greatest!
diff --git a/docs/src/content/self-hosting.mdx b/docs/src/content/self-hosting.mdx
index c54fc18c7..21891f5f6 100644
--- a/docs/src/content/self-hosting.mdx
+++ b/docs/src/content/self-hosting.mdx
@@ -1,7 +1,7 @@
import { Steps } from 'nextra/components'
import { Callout } from 'nextra/components'
-# Self Hosting
+# Setup
This guide will walk you through setting up your own instance of Rybbit.
diff --git a/docs/src/content/track-events.mdx b/docs/src/content/track-events.mdx
index 72687034a..e6fa68686 100644
--- a/docs/src/content/track-events.mdx
+++ b/docs/src/content/track-events.mdx
@@ -1,4 +1,4 @@
-# Track Events
+# Track Custom Events
The script exposes a global object `window.rybbit` with functions for manual tracking of events.
diff --git a/docs/src/content/tracker.mdx b/docs/src/content/tracker.mdx
index a1a85e1bb..5328825d0 100644
--- a/docs/src/content/tracker.mdx
+++ b/docs/src/content/tracker.mdx
@@ -1,4 +1,4 @@
-# Install Tracker
+# Tracker Configuration
To start tracking user activity on your website, add the Rybbit tracking script to your site's HTML.