CaptiFi Documentation Site

Customer-facing documentation for the CaptiFi guest WiFi marketing platform.

Live: https://docs.captifi.io

Tech Stack

• VitePress v1.6.4 — static site generator
• Markdown with YAML frontmatter
• Auto-generated sitemap
• Built-in local search

Development

# Install dependencies
npm install

# Start dev server
npm run docs:dev

# Build for production
npm run docs:build

# Preview production build
npm run docs:preview

Deployment

The site is served from /var/www/captifi-docs/ on captifi-server, built on the server from a source checkout at /var/www/captifi-docs-src (pulls via a read-only deploy key, SSH host alias github-captifi-docs).

# 1. Commit and push to master
git push origin master

# 2. Pull + build + publish on the server (over Tailscale; public-IP SSH is firewalled)
ssh root@captifi-server /usr/local/bin/deploy-captifi-docs

The deploy script does: git pull --ff-only → npm ci → vitepress build → rsync --delete into the web root, and prints the deployed commit.

Structure

├── .vitepress/
│   ├── config.mts          # Site config, nav, sidebar
│   └── theme/
│       ├── index.ts         # Theme extensions
│       └── custom.css       # Brand CSS overrides
├── billing/                 # Plans, subscription, payments
├── dashboard/               # 14 dashboard feature guides
├── faq/                     # General, hardware, billing, GDPR
├── getting-started/         # 7 onboarding guides
├── integrations/            # Google Reviews, Mailchimp, Revinate
├── public/                  # Static assets (favicon, robots.txt)
├── setup-guides/            # CaptiFi device + 6 vendor integrations
├── tips/                    # 5 best-practice guides
├── troubleshooting/         # LED guide, common issues, reset, network
├── index.md                 # Homepage
└── whats-new.md             # Changelog / release notes

Content Guidelines

• No developer references — no PHP, Livewire, Filament, API endpoints, database fields, or component names
• Plan names — Essentials (£49/mo), Growth (£89/mo), Multi-Site (£149/mo), Enterprise (custom); annual = £39/£69/£119 per month
• Extra sites — every plan includes 1 site; each additional site is £25/mo (prorated, self-serve)
• Trial — 30 days, payment method required up front, no charge until the trial ends
• Hardware — £60 refundable hold, released on device return; kit = device + Ethernet cable; activation PIN arrives by email / dashboard
• Dashboard — customer docs describe the NEW dashboard (my.captifi.io); app.captifi.io is the "classic dashboard"
• Portal server — splash IP is 46.62.168.7; device tunnel is WireGuard UDP 51820 (never cite 157.230.53.133 or OpenVPN 1194)
• Every page needs — YAML frontmatter with title and description
• Setup guides need — Walled garden entries, troubleshooting table, Need Help section
• Use British English — colour, centre, organise, etc.
• Country-neutral — customers are worldwide: write "power socket" not "UK mains socket", cite UK bodies/laws (ICO, UK GDPR, PECR) only as examples alongside local equivalents (CAN-SPAM, CASL, CCPA), and note that delivery times and taxes vary by country. Prices stay in GBP.

SEO

• All 52 pages have unique <title> and <meta description> tags
• Open Graph and Twitter card meta in config
• Auto-generated sitemap at /sitemap.xml
• robots.txt referencing the sitemap