From 18d8b16a2cbe836d52c26a6344bcfe5b0773ee66 Mon Sep 17 00:00:00 2001 From: Sunil Thakares Date: Wed, 17 Jun 2026 16:49:47 +0530 Subject: [PATCH] docs: update documentation for v0.4.0 release --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++--- docs/CHANGELOG.md | 24 +++++++++++++++++ docs/DOCKER-Deploy.md | 27 ++++++++++++++++++- docs/TESTING.md | 13 +++++++++ 4 files changed, 121 insertions(+), 4 deletions(-) create mode 100644 docs/CHANGELOG.md diff --git a/README.md b/README.md index f71643c..bd87f51 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,28 @@ Built with Rust, SQLite, Axum, and Askama, BZOD is designed for individuals, org ## Highlights -### v0.3.0 +### v0.4.0 +* Raw visitor activity logs +* Analytics drill-down pages +* Visitor pagination +* Advanced sliding-window pagination +* CSV analytics export +* JSON analytics export +* Date-filtered analytics +* Landing page analytics +* Human-readable custom slugs +* Root landing page support +* UTM campaign builder +* Built-in backup and restore +* CLI shorten command +* CLI expand command +* QR code generation +* Password-protected links +* Smart preview pages +* Analytics dashboard +* Audit logging +* Health monitoring * Human-readable custom slugs * Root landing page support * Landing page custom slugs @@ -49,6 +69,12 @@ Built with Rust, SQLite, Axum, and Askama, BZOD is designed for individuals, org | Backup & Restore | ✅ | | UTM Campaign Builder | ✅ | | CLI Automation | ✅ | +| Raw Visitor Logs | ✅ | +| Analytics Export (CSV) | ✅ | +| Analytics Export (JSON) | ✅ | +| Analytics Drill-Down | ✅ | +| Date Range Analytics | ✅ | +| Advanced Pagination | ✅ | | Geo Analytics | 🚧 | | Multi-User Administration | 🚧 | | SSO | 🚧 | @@ -119,7 +145,7 @@ https://bzo.in/1b926e ``` Custom Slug ``` -https://bzo.in/!office +https://bzo.in/!myoffice ``` Landing Page ``` @@ -261,12 +287,12 @@ https://example.com/page?utm_source=email&utm_medium=newsletter&utm_campaign=lau No additional database schema changes are required. --- - ### Analytics Track: * Total visits +* Unique visitors * QR scans * Countries * Referrers @@ -275,6 +301,35 @@ Track: * Monthly statistics * Yearly statistics +Analytics drill-down includes: + +* Raw visitor activity logs +* Visitor IP addresses +* Country information +* Referrer tracking +* Browser detection +* Raw User-Agent display +* Date range filtering +* CSV export +* JSON export +* Paginated visitor logs + +Analytics Export + +Export analytics data directly from the administration interface. + +Supported formats: + +* CSV +* JSON + +Features: + +* Memory-safe export handling +* Date-range filtering +* Downloadable files +* Compatible with spreadsheets and BI tools + --- ### Audit Trail diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..16b8f30 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,24 @@ +# Changelog + +## v0.4.0 + +### Added + +* Raw visitor activity logs +* Analytics drill-down pages +* Date-range analytics filters +* CSV export +* JSON export +* Advanced pagination +* Visitor log tables + +### Improved + +* Registry pagination +* Analytics navigation +* Export performance + +### Fixed + +* Pagination edge cases +* Analytics sorting consistency \ No newline at end of file diff --git a/docs/DOCKER-Deploy.md b/docs/DOCKER-Deploy.md index f1a853b..9e8065c 100644 --- a/docs/DOCKER-Deploy.md +++ b/docs/DOCKER-Deploy.md @@ -207,8 +207,21 @@ COOKIE_SECURE=true when HTTPS is enabled. --- +# Analytics Export -# Backup +Analytics pages support: + +* Raw visitor logs +* CSV export +* JSON export +* Date filtering + +Exports can be generated from: + +Admin → Analytics + +Backup +--- ## Web UI @@ -393,7 +406,17 @@ Verify: ```bash docker logs -f bzod ``` +# Upgrading to v0.4.0 +1. Backup databases +2. Pull latest source +3. Rebuild container +4. Restart service + +```bash +git pull +docker compose build --no-cache +docker compose up -d --- # Troubleshooting @@ -420,6 +443,8 @@ docker exec -u 0 -it bzod bash chown -R bzod:bzod /app/data ``` +docker exec -it bzod bzod doctor + Restart: ```bash diff --git a/docs/TESTING.md b/docs/TESTING.md index 58076d9..2079adb 100644 --- a/docs/TESTING.md +++ b/docs/TESTING.md @@ -395,7 +395,20 @@ Expected Result: * No migration failures --- +## Analytics Verification +Verify: + +* URL analytics page loads +* Landing page analytics page loads +* Visitor activity table renders +* Empty visitor tables render correctly +* CSV export downloads successfully +* JSON export downloads successfully +* Date filtering works +* Invalid date filters return HTTP 400 +* Pagination preserves active filters +* Exports respect active filters # Release Acceptance Criteria A release is considered production-ready only if: