Skip to main content

​
Overview

WhatDoc provides flexible deployment options for hosting your documentation. Every project gets a default URL, and you can upgrade to custom subdomains or bring your own domain.

​
Default Deployment

Every project is automatically deployed at: 
https://whatdoc.xyz/p/your-slug
Where your-slug is the URL slug you set during project configuration. Characteristics:
  • Publicly accessible by default (isPublic: true)
  • Instant deployment (no DNS configuration needed)
  • SEO-friendly URLs
  • Free for all tiers

​
Custom Subdomain

Upgrade your documentation URL to a branded subdomain: 
https://your-name.whatdoc.xyz

​
Setting Up a Subdomain

1

Navigate to Settings

Go to your project settings at /settings/:projectId or edit your project at /editor/:projectId.
2

Enter Subdomain

In the Domains tab (Settings page) or Settings drawer (Editor), enter your desired subdomain.Requirements:
  • Lowercase letters, numbers, and hyphens only
  • Must be unique across all WhatDoc projects
  • Minimum 2 characters
The input field automatically sanitizes your entry:
subdomain.toLowerCase()
  .replace(/[^a-z0-9-]/g, '')
  .replace(/-+/g, '-')
  .replace(/^-|-$/g, '')
3

Save Subdomain

Click Save Subdomain or Save & Deploy.If the subdomain is already taken, you’ll see: Subdomain is taken.Otherwise, your documentation is instantly available at:
https://your-subdomain.whatdoc.xyz
4

Update Links

The subdomain becomes your primary documentation URL. The old slug URL (/p/slug) remains accessible but the subdomain takes precedence in the UI.
Subdomain changes are instant—no DNS propagation required. WhatDoc handles routing automatically.

​
Custom Domain (Beta)

Custom domains are currently in BETA: TESTING MODE. Cloudflare SSL provisioning and DNS propagation can occasionally take up to 24 hours to stabilize.
Connect your own domain to host documentation on your infrastructure: 
https://docs.your-startup.com

​
Setting Up a Custom Domain

1

Go to Domains Tab

Navigate to /settings/:projectId and click the Domains tab.
2

Enter Custom Domain

In the Custom Domain section, enter your domain:
docs.example.com
The field accepts:
  • Subdomains (e.g., docs.example.com, help.example.com)
  • Apex domains (e.g., example.com)
  • Lowercase letters, numbers, dots, and hyphens
3

Click Connect

Click Connect to save the custom domain.If the domain is already in use by another project, you’ll see an error: Custom domain update failed. It may be in use.
4

Configure DNS

You’ll see DNS configuration instructions:
TYPE   CNAME
NAME   docs (or your subdomain)
TARGET cname.whatdoc.xyz
Steps:
  1. Log in to your domain registrar or DNS provider (e.g., Cloudflare, Namecheap, GoDaddy)
  2. Add a new CNAME record:
    • Name/Host: Your subdomain (e.g., docs)
    • Value/Target: cname.whatdoc.xyz
    • TTL: Automatic or 3600 seconds
  3. Save the record
5

Wait for Propagation

DNS propagation typically takes:
  • 5-15 minutes: For most providers
  • Up to 24 hours: In rare cases or with slower DNS providers
You can check propagation status using:
dig docs.example.com CNAME
nslookup docs.example.com
6

SSL Provisioning

WhatDoc automatically provisions an SSL certificate via Cloudflare once DNS propagates.Your documentation will be accessible at:
https://docs.example.com

​
DNS Configuration Example

For domain docs.startup.com, add this CNAME record:
TypeNameTargetTTL
CNAMEdocscname.whatdoc.xyzAuto
For apex domain startup.com (not recommended):
TypeNameTargetTTL
CNAME@cname.whatdoc.xyzAuto
Some DNS providers (like Cloudflare) support CNAME flattening for apex domains. Check your provider’s documentation.

​
URL Priority

When multiple URLs are configured, WhatDoc prioritizes them as follows:
  1. Custom Domain (if set): https://docs.example.com
  2. Subdomain (if set): https://my-project.whatdoc.xyz
  3. Default Slug: https://whatdoc.xyz/p/my-project
All URLs remain accessible, but the highest priority URL is displayed in the UI and shared publicly.

​
Live URL Display

Your current live URL is shown in multiple places:
  • Dashboard: On the project card
  • Settings: In the General tab (with copy button)
  • Editor: In the subdomain field
You can click the View Live button to open your documentation in a new tab.

​
Deployment Pipeline

When you save changes via the editor or settings: 
await projectApi.update(projectId, {
  subdomain: 'my-org',
  customDomain: 'docs.example.com',
  generatedDocs: '# Updated docs',
  customization: { ... }
});
Changes go live instantly—no build process or queue delays.

​
Removing Custom Domains

To remove a custom domain:
  1. Go to /settings/:projectId > Domains tab
  2. Clear the Custom Domain field
  3. Click Connect (saves as null)
  4. Optionally, remove the CNAME record from your DNS provider
Your documentation reverts to the subdomain or default slug URL.

​
Security & SSL

  • Automatic SSL: All URLs (default, subdomain, custom domain) are served over HTTPS
  • Certificate Management: Handled automatically by Cloudflare
  • HSTS: Enabled for enhanced security
  • No Configuration Needed: SSL works out of the box
All WhatDoc documentation is served securely over HTTPS with automatic SSL certificate provisioning.

​
Troubleshooting

​
Subdomain Issues

IssueCauseSolution
”Subdomain is taken”Another project uses this subdomainChoose a different subdomain
Subdomain not loadingRecent change, cache delayClear browser cache, wait 1-2 minutes
Invalid subdomain errorContains special charactersUse only letters, numbers, hyphens

​
Custom Domain Issues

IssueCauseSolution
”Domain may be in use”Another project uses this domainUse a different domain or contact support
DNS not resolvingCNAME record not set or propagatingWait 15 minutes, check DNS with dig
SSL certificate errorCertificate provisioning in progressWait up to 24 hours, check Cloudflare status
404 on custom domainDNS points elsewhereVerify CNAME target is cname.whatdoc.xyz

​
Checking DNS Propagation

Linux/Mac: 
dig docs.example.com CNAME +short
# Should return: cname.whatdoc.xyz
Windows: 
nslookup -type=CNAME docs.example.com
Online Tools:

​
Best Practices

Do:
  • Use subdomains like docs., help., or api. for documentation
  • Keep subdomain names short and memorable
  • Test DNS changes with dig before reporting issues
  • Wait at least 15 minutes after DNS changes
Don’t:
  • Use apex domains (e.g., example.com) unless your DNS provider supports CNAME flattening
  • Change DNS records frequently (causes propagation delays)
  • Mix HTTP/HTTPS links (use HTTPS everywhere)
  • Use long or complex subdomain names

​
What’s Next?

Customizing Docs

Add your logo, branding, and navigation

BYOK

Use your own API key for unlimited generation

Build docs developers (and LLMs) love

Get started for freeTalk to us