Every domain's documentation lives on its own docs.<domain>. A domain can hold one docs site or many:
| On docs.acme.com | What it shows |
|---|---|
| A site at the root | docs.acme.com/ is that site's home page, and its pages are docs.acme.com/<page>. |
| Sites under a path | Each site lives at docs.acme.com/<site>, with a link back to the list. |
| No site at the root | docs.acme.com/ lists every site on the domain, with search and categories — this is how docs.appneural.com shows every APPNEURAL product. |
The first site you put on a domain goes to the root; later ones go under their own path. Change it on the site's Domain tab.
Add a domain
- Open Studio → Domains and type the domain, for example
acme.com. Domains in the Cloudflare account are suggested as you type. - Connect docs.acme.com. The Studio adds a proxied
AAAA docs 100::record and the Worker routedocs.acme.com/*in the domain's Cloudflare zone, then checks that it answers. - Put sites on it. Press New site on acme.com, or pick the domain on an existing site's Domain tab.
One-click Connect needs the CLOUDFLARE_API_TOKEN secret on the Worker, with Zone → Zone → Read, Zone → DNS → Edit and Zone → Workers Routes → Edit for the zones you want to use.
Important
Connect never overwrites anything. If docs.<domain> already has a DNS record, or its route belongs to another Worker, it stops and says what is in the way.
The directory
When no site is at the root, docs.<domain>/ shows the domain's directory. On Domains, open the domain to set its name, headline, color and logo. Sites appear in it while they are published and listed (Settings → Visibility), grouped by their category.
Connect by hand
Without the token, do the same two things in the Cloudflare dashboard for the zone:
| Where | What |
|---|---|
| DNS → Records → Add record | Type AAAA, name docs, IPv6 address 100::, Proxy status Proxied |
| Workers Routes → Add route | Route docs.<domain>/*, Worker documentation-catalog |
Then press Check.
Warning
Use a route, not a Worker custom domain. Each deploy replaces the Worker's custom domains with the ones in wrangler.jsonc, which would remove it. Only docs.appneural.com is a custom domain there.
Before and after the domain is live
Until docs.<domain> answers, every site on it is readable at documentation.appneurox.com/<site>. Once it answers, visitors who open those platform addresses are sent on to docs.<domain>, and search engines are pointed there. In the Studio you still see the platform address, drafts included.
Disconnect
Disconnect removes the route and the DNS record the Studio created, and nothing else. The sites stay readable on the platform.
Troubleshooting
| What you see | What to do |
|---|---|
| No active Cloudflare zone … is visible to the API token | Add the domain to the Cloudflare account, or give the token access to its zone. |
| docs.acme.com already has a DNS record | Remove the old record if it is unused, then connect again. |
| More than one level below the zone | For docs.shop.acme.com, turn on Total TLS or add an advanced certificate for the zone. |
| docs.acme.com/ already shows another site | Only one site can be at the root. Put this one under a path, or move the other first. |
| Check says it answered, but not from this service | Another Worker or server owns the address. Check the route and record. |