DocumentationREST APIAPI Reference

Site settings

SEO and sharing

Configure search metadata, social sharing, and sitemap behavior for your published docs site

What this page covers

The SEO and sharing settings control how your published docs site appears to search engines and how its links look when shared on social platforms. Set these once for the whole site, then publish to make them live.

How the published site is discovered

Published docs sites serve routes that search engines and AI tools read:

RouteWhat it provides
/sitemap.xmlA list of the site's docs pages for search engine crawlers.
/llms.txtAn AI-friendly index of the site's content.
/llms-full.txtA longer AI-friendly version of the site's content.

The sitemap is built from the site's page list, so every page you add to the docs appears in it. Keep your navigation complete so that every page is linked from the sidebar or header. See Navigation for how pages are organized.

Canonical URLs and the public host

Canonical URLs, social metadata, AI-native route URLs, and sitemap entries should all use the same public host. When they match, search engines treat your pages as one site.

  • Before you attach a domain, your site is served at <slug>.doxa.page.

  • After you attach a custom domain, use that domain for the links you share. See Custom Domains.

Note:

If the links in your site point at a different host than the one readers use, search ranking can split between two addresses. Attach your custom domain and confirm it serves your docs before you promote the site.

Sharing previews

When someone shares a link to your docs, social platforms read the site's metadata to build a preview card. Use a clear site title and a short description that names the project and what the docs cover. Both are often shown alone in search results and link previews, so keep them specific.

Verify your changes

  1. Publish the branch that contains your changes.

  2. Open /sitemap.xml on your site's host (for example, <slug>.doxa.page) and confirm it lists your pages.

  3. Open /llms.txt on the same host to confirm the AI-friendly index is served.

Advanced JSON

Edit the full site configuration as JSON, validated by the published JSON Schema.

Features

Turn search and API reference pages on or off for readers.

Custom Domains

Attach a domain and confirm it serves your docs.