Connecting a Custom Domain
Connecting a custom domain lets you serve your documentation, changelog, and help center pages from your own branded web address instead of the default Hyperdocs subdomain. This makes your docs feel like a seamless part of your product and builds trust with your readers.
How It Works
•Your site is always available on a default Hyperdocs subdomain, so it stays live even before you add a custom domain.
•You can connect a custom subdomain, such as docs.yourcompany.com, to point readers to your own address.
•After adding a domain, Hyperdocs walks you through verifying ownership and connection status.
•You can monitor whether the domain is pending, verified, or fully connected directly from your settings.
•Once connected, all your published docs, changelog, and home pages are served automatically on the new domain.
Steps
1.Open your admin dashboard and go to the Domain settings section.
2.Enter the custom subdomain you want to use, for example docs.yourcompany.com.
3.Save the subdomain to begin the connection process.
4.Add the DNS records shown by Hyperdocs to your domain provider to point the subdomain to your site.
5.Return to the Domain settings and check the connection status until it shows as verified.
6.Once verified, publish your site to make it available on your custom domain.
Domain Connection Status
Status | What It Means |
|---|---|
Default subdomain | Your site is live on the built-in Hyperdocs subdomain with no setup required. |
Pending verification | You have added a custom subdomain, but DNS records have not yet been confirmed. |
Verified | DNS records are confirmed and your domain is ready to serve docs. |
Connected | Your published site is live on your custom domain. |
Tips
•Use a clear, memorable subdomain like docs or help so readers can easily guess and remember your documentation address.
•DNS changes can take time to spread across the internet, so wait a little while before assuming the connection failed.
•Keep your default Hyperdocs subdomain in mind as a reliable fallback while you finish setting up the custom domain.
Your site remains fully accessible on the default Hyperdocs subdomain at all times, even while a custom domain is still verifying.
Double-check that the DNS records you copy into your domain provider exactly match the ones shown in Hyperdocs to avoid delays.
Troubleshooting
•If your domain stays in pending verification, confirm the DNS records were added correctly at your domain provider and saved.
•If the verified domain does not show your latest content, make sure you have published the site after connecting it.
•If you mistyped the subdomain, remove it from Domain settings and add the correct address again.
•If readers reach an error page, verify the connection status is showing as connected before sharing the link.
Related topics: Configure Branding and General Settings, Preview and Publish the Site, View Dashboard Overview.