---
title: Links to a glossary or terminology page
description: "Agents that don't already know your domain vocabulary need a place to look it up. A glossary or terminology page linked from every doc page gives them a single authoritative source for \"what does this term mean in this product\"."
doc_version: 0.2.0
last_updated: "2026-04-24T21:30:56.217Z"
---

## How the check decides

The check enumerates every `<a>` element on the page and asserts at least one has visible link text matching `glossary` or `terminology` (case-insensitive). Fails if no such link exists.

## How to implement it

Publish a `/glossary/` (or `/terminology/`) page and link to it from your global site footer or sidebar so every page picks the link up automatically.

### Pass

```html
<footer>
  <a href="/glossary">Glossary</a>
  <a href="/about">About</a>
</footer>
```

### Fail

```html
<footer>
  <a href="/about">About</a>
  <a href="/contact">Contact</a>
</footer>
```

## Common gotchas

The check matches link **text**, not href — naming the file `vocab.html` is fine as long as the visible link text says "Glossary" or "Terminology". Conversely, a footer link to `/glossary/` whose visible text reads "Definitions" won't satisfy the check.

Add the glossary link to a shared layout component (header, footer, or sidebar) rather than to individual pages — that way every page picks it up automatically without per-page maintenance.

A real glossary page is more useful than a stub. Even a flat list of 10–15 core terms with one-paragraph definitions is dramatically more useful for an agent than a placeholder, because it lets the agent disambiguate vocabulary without parsing your entire docs corpus first.

## Sitemap

Full docs site index: [/sitemap.md](/sitemap.md).
