AlgoQuill
AlgoQuill Docs
Dashboard

Understanding AlgoQuill Hosting

AlgoQuill provides two ways to host your documentation:

1. Free Subdomain (All Plans)

Every project gets a free subdomain like your-project.algoquill.ai. This is automatically generated when you create a project and works immediately after you deploy to production.

How it works:

The subdomain shown in your project sidebar (e.g., "my-docs-abc123.algoquill.ai") will become a live URL once you deploy to Vercel. Currently in development, it's just a placeholder.

2. Custom Domain (Starter+ Plans)

With a paid plan, you can connect your own domain like docs.yourcompany.com.

Deploying to Vercel

Step 1: Create a Vercel Account

  1. Go to vercel.com
  2. Sign up with GitHub (recommended)
  3. Connect your GitHub account

Step 2: Prepare Your Repository

  1. Push your AlgoQuill code to a GitHub repository
  2. Make sure your .env.local file is in .gitignore

Step 3: Deploy

  1. In Vercel, click "Add New Project"
  2. Import your GitHub repository
  3. Add environment variables (copy from your .env.local)
  4. Click "Deploy"

Required Environment Variables

NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key
ANTHROPIC_API_KEY=your-claude-api-key
STRIPE_SECRET_KEY=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-webhook-secret
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your-stripe-pub-key
GITHUB_TOKEN=your-github-token (optional)

Setting Up Custom Domains

Step 1: Add Domain in AlgoQuill

  1. Go to your project → Configure → Custom Domains
  2. Enter your domain (e.g., docs.yourcompany.com)
  3. Click "Add Domain"
  4. You'll see DNS records to add

Step 2: Add DNS Records

Go to your domain registrar (GoDaddy, Namecheap, Cloudflare, etc.) and add:

TypeNameValue
CNAMEdocscname.vercel-dns.com
Why "No DNS Found"?

You're seeing this because:

  1. The app isn't deployed to production yet (it's on localhost)
  2. DNS records haven't been added at your domain registrar
  3. DNS propagation takes 5-60 minutes after adding records

Step 3: Verify in Vercel

  1. In Vercel, go to your project → Settings → Domains
  2. Add the same domain
  3. Vercel will verify the DNS and issue an SSL certificate

Step 4: Verify in AlgoQuill

  1. After DNS propagates (5-60 minutes)
  2. Go back to Custom Domains in AlgoQuill
  3. Click "Verify" - it should now show as verified

Buying a Domain

If you don't have a domain yet, here are recommended registrars:

  • Porkbun - Cheapest, great for startups
  • Cloudflare - At-cost pricing, good DNS
  • Namecheap - Popular, good support
  • Google Domains - Simple, reliable

Production Checklist

  • ☐ Push code to GitHub
  • ☐ Create Vercel account
  • ☐ Deploy to Vercel
  • ☐ Add environment variables
  • ☐ Set up Stripe webhook for production URL
  • ☐ Configure custom domain (optional)
  • ☐ Add DNS records
  • ☐ Submit sitemap to Google Search Console
  • ☐ Test all features