Master this essential documentation concept
The ability to publish documentation on a branded domain name (e.g., docs.yourcompany.com) rather than a generic subdomain.
Custom Domain Hosting is the practice of mapping your documentation site to a domain name you own and control, rather than relying on the default subdomain provided by your documentation platform. Instead of directing users to yourcompany.docsplatform.com, your team publishes everything at docs.yourcompany.com, creating a cohesive digital presence that aligns with your brand standards.
A SaaS company's help documentation lives at help.docsplatform.com, causing users to feel they've left the product environment. Support tickets increase because users distrust the external-looking domain, and SEO value from thousands of help articles benefits the platform vendor instead of the company.
Configure a custom domain at help.yourproduct.com using CNAME DNS records, provision an SSL certificate through the documentation platform, and update all in-app help links to the new branded URL.
1. Log into your domain registrar and navigate to DNS settings. 2. Create a CNAME record: help.yourproduct.com pointing to your platform's alias. 3. In your documentation platform dashboard, add the custom domain and trigger SSL provisioning. 4. Wait for DNS propagation (up to 48 hours). 5. Test HTTPS access and verify redirects from old URLs. 6. Update all in-app links and email templates to reference the new domain. 7. Set up Google Analytics to track the new subdomain.
Users experience seamless navigation between the product and documentation. SEO rankings improve as help articles index under the company domain. Support ticket volume decreases by an estimated 15-25% due to increased trust and discoverability.
A platform company publishes API references on a generic subdomain, causing developers to question the documentation's authority and freshness. Developer portal branding is inconsistent, and the company cannot enforce its security headers or compliance policies on the documentation domain.
Establish api-docs.yourcompany.com as the canonical developer documentation hub, integrating it visually and technically with the main developer portal at developers.yourcompany.com.
1. Audit existing developer documentation URLs and document all inbound links. 2. Create a CNAME record for api-docs.yourcompany.com in DNS. 3. Configure the documentation platform with the custom domain and enable HTTPS. 4. Set up 301 redirects from the old platform subdomain to preserve link equity. 5. Add custom headers (CSP, HSTS) through platform settings or a CDN layer. 6. Notify developer community via changelog and API newsletter. 7. Update SDK README files and GitHub repositories with new documentation URLs.
Developer trust increases as documentation appears authoritative and officially maintained. Security compliance requirements are met. Inbound links from GitHub repositories and developer blogs now contribute to company domain authority.
A software company with three products has documentation scattered across different platform subdomains with no consistent URL structure. Users cannot intuitively navigate between product docs, and the marketing team cannot run unified campaigns linking to documentation.
Create a structured subdomain architecture — docs.company.com as a hub, with product-specific paths or subdomains (product1.docs.company.com) all configured as custom domains pointing to the documentation platform.
1. Define URL architecture: docs.company.com/product1, docs.company.com/product2, or separate subdomains per product. 2. Configure multiple CNAME records in DNS for each subdomain. 3. Set up separate documentation spaces in the platform, each mapped to its custom domain. 4. Create a landing page at docs.company.com that links to all product documentation. 5. Implement consistent navigation headers across all documentation spaces. 6. Configure cross-space search if the platform supports it. 7. Set up unified Google Analytics with cross-domain tracking.
Users navigate intuitively across all product documentation. Marketing campaigns can link directly to relevant docs with confidence. The unified domain structure improves overall SEO performance across all product documentation.
An enterprise is migrating from an outdated internal wiki to a modern documentation platform. Thousands of internal links and bookmarks reference the old system's URLs, and the IT team requires documentation to remain on an approved internal domain for compliance purposes.
Configure the new documentation platform to serve content at the same internal domain (knowledge.company.com) previously used by the old wiki, ensuring zero disruption to existing bookmarks and links.
1. Inventory all existing documentation URLs and identify high-traffic pages. 2. Set up the new documentation platform with knowledge.company.com as the custom domain. 3. Migrate content to the new platform while maintaining URL slug consistency where possible. 4. Configure 301 redirects for any URLs that must change structure. 5. Update DNS records to point knowledge.company.com to the new platform. 6. Coordinate a cutover window with IT and communicate to all staff. 7. Monitor 404 errors for two weeks post-migration and fix broken links promptly.
Migration completes with minimal user disruption. Existing bookmarks continue to work. Compliance requirements are satisfied because documentation remains on an approved company domain. Adoption of the new platform is higher due to familiar URL patterns.
Before setting up custom domain hosting, define a clear and scalable subdomain strategy that can accommodate future documentation growth, multiple products, and different audience types (users, developers, partners).
SSL/TLS certificates are non-negotiable for custom documentation domains. They protect user data, are required for modern browser trust indicators, and are a confirmed SEO ranking factor. Certificate expiration causes immediate site unavailability.
When migrating from a platform subdomain to a custom domain, all existing inbound links, bookmarks, and search engine indexes point to the old URL. Without proper redirects, you lose traffic, break user bookmarks, and waste accumulated SEO value.
A custom domain enables unified analytics tracking across your website and documentation. Without proper configuration, documentation traffic appears as a separate, unrelated property, making it impossible to track user journeys from marketing pages through to documentation.
DNS configurations for custom domains are often set up once and forgotten until something breaks. When the original configurator leaves the organization or the domain registrar account credentials are lost, teams face costly outages and recovery challenges.
Join thousands of teams creating outstanding documentation
Book a Demo