SEO & GEO

Sitemap

Configure and control sitemap.xml generation for your Documentation.AI site, including Site Config options, JSON config keys, and common issues.

Overview

The sitemap lists all crawlable pages in your published documentation so search engines can discover, understand, and index your content correctly.

Documentation.AI serves a sitemap for every published site at the root URL /sitemap.xml. The sitemap is generated automatically from your published docs structure and page metadata; you do not edit the XML directly.

The sitemap always reflects your public published content state. When you publish new pages, rename or move existing ones, or unpublish content, the sitemap updates to match.

Access and verify sitemap.xml

Access your sitemap at your docs base URL with /sitemap.xml appended, then verify that it lists your published pages.

Open your live docs site

Publish at least one page from the Web Editor or Code Editor workflow.
Open your live documentation site in a new browser tab.
Confirm you see your docs homepage and navigation.

Visit the sitemap URL

In the browser address bar, append /sitemap.xml to your docs base URL.
For example, if your docs are at https://docs.acme.dev, open https://docs.acme.dev/sitemap.xml.
Your browser should display an XML document listing your documentation URLs.

Confirm it reflects recent changes

Create or update a public page and publish your changes.
Refresh /sitemap.xml in your browser.
Look for the new or updated page URL in the sitemap output.

If you rename, move, or unpublish a page and republish, the sitemap drops the old URL and includes the new one when your next deployment goes live.

The sitemap lists URLs for published public pages from your latest deployment. Drafts and unpublished pages do not appear.

Enable or disable sitemap generation

Control whether Documentation.AI generates and serves /sitemap.xml using either Site Config in the Editor or the global SEO keys in your root documentation.json.

Using the Editor

Use Site Config in the Editor when you prefer not to edit documentation.json directly.

Open sitemap settings

In the Editor, click Site Config in the top toolbar, then select SEO.

Toggle sitemap generation

Use the Enable sitemap generation toggle to control whether Documentation.AI generates and serves /sitemap.xml.
Turn the toggle on to generate a sitemap for your published docs, or off to disable sitemap generation.

Publish changes to apply sitemap settings

Publish or redeploy your documentation so the updated sitemap setting goes live.
After deployment, visit /sitemap.xml to confirm the sitemap behavior matches your setting.

Using documentation.json

Set global sitemap behavior directly in your root documentation.json file using the seo object. This mirrors the setting configured in Site Config.

To enable sitemap generation:

{
  "seo": {
    "sitemap:enabled": true
  }
}

To disable sitemap generation:

{
  "seo": {
    "sitemap:enabled": false
  }
}

Apply this setting once at the root level so sitemap behavior is consistent across your docs.

Sitemap generation is separate from indexing behavior. The seo.sitemap:enabled setting controls whether Documentation.AI generates and serves /sitemap.xml, while robots-related SEO settings control how search engines index and treat the URLs they discover.

Was this page helpful?

Last updated 3 days ago

Built with Documentation.AI