> For the complete documentation index, see [llms.txt](https://docs.direqt-search.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.direqt-search.com/content-indexing/indexing-best-practices.md).

# Indexing Best Practices

To ensure we can successfully index your site and provide the best possible search experience, follow these best practices to optimize your website's structure and accessibility.

### Host a Sitemap at Your Site's Root

A sitemap helps us efficiently locate and index your content.

**Best Practices:**

* Create an **XML** sitemap following the [Sitemaps.org protocol](https://www.sitemaps.org/).
* Post the sitemap at your site root (e.g., `https://yourdomain.com/sitemap.xml`) for easy discovery.
* Verify that your sitemap is publicly accessible by opening it in a browser.
* Ensure your sitemap is referenced in `robots.txt`

### Ensure URLs Are Publicly Accessible

If your site blocks access, we won’t be able to index it.

**Best Practices:**

* Test your URLs in Incognito Mode to ensure they load without login credentials
* Ensure no firewall, VPN, or bot protection is blocking access to our crawler
* Remove `noindex` meta tags from pages that should be indexed

### Avoid Redirect Loops

If a page redirects too many times, we may not be able to follow it.

**Best Practices:**

* Ensure URLs resolve within one or two redirects (e.g., `http → https`, `www → non-www`)
* Avoid redirect loops (`URL A → URL B → URL A`)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.direqt-search.com/content-indexing/indexing-best-practices.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
