What The Assistant Uses

The Relevate Assistant answers from your published documentation. During a build, Relevate prepares page-level records that include metadata, page content, section anchors, locale, and canonical URLs.

Those exports power:

  • The hosted docs assistant experience

  • Markdown page responses requested with .md or Accept: text/markdown

  • /skill.md for agent and tool discovery

  • Assistant search and answers in hosted docs

The assistant is grounded in the docs build output, not a separate copy of your content.

What Gets Indexed

For each visible page, Relevate writes an AI-friendly record with:

  • Page title and description

  • Absolute page URL

  • Canonical slug and locale

  • Last updated metadata when available

  • Section headings and anchor IDs

  • Body content in a Markdown-oriented format

Hidden and noindex pages are excluded from public Markdown export and assistant-ready records.

Assistant Behavior

When the assistant is enabled, it:

  • Searches the docs knowledge base before answering

  • Keeps answers scoped to the current docs instance

  • Uses page and section URLs when links help

  • Avoids inventing undocumented features or APIs

  • Answers in the reader's context when the relevant docs exist

The assistant is intentionally docs-scoped. If the documentation does not support an answer, the right behavior is to say that clearly instead of filling the gap with a guess.

Make Pages Assistant-Friendly

The same writing choices that help humans also help the assistant.

1

Use specific titles

Prefer Configure SSO over Settings. The title becomes part of the page record.

2

Write descriptive frontmatter

The description field gives the assistant a compact summary before it reads the page body.

3

Keep sections focused

Short sections with clear headings produce better anchors and better retrieval.

4

Use exact product terms

If your UI says sync now, use that phrase in the docs. The assistant can only ground answers in what you publish.

5

Add examples near the explanation

Put snippets next to the concept they explain so retrieval returns the example with the instructions.

Good Page Pattern

---

title: Configure API Keys

description: Create, rotate, and revoke API keys from the dashboard.

---



# Before You Start



Sign in to the dashboard with an account that can manage API keys.



# Create A Key



Open Settings, choose API keys, and create a new key for your environment.



# Rotate A Key



Create a replacement key, update your application, then revoke the old key.

This page has a clear task, a specific title, and headings that map to reader intent.

What To Document First

The assistant gets much better when the docs answer common setup and troubleshooting questions directly.

  • Installation and first-run guides

  • Authentication and API key setup

  • Configuration reference pages

  • Error messages and troubleshooting steps

  • Product limits, permissions, and billing behavior

Related Files

Markdown And Text Exports

Learn how .md URLs, Accept: text/markdown, and /skill.md work.

Personalization

Tailor documentation and examples to authenticated readers.

Full Image