Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Reference

Short definitions

Let readers open a brief definition with a click, tap, or keyboard.

Updated
Read as Markdown

Use <InfoHint> for a short definition that readers can open when they need it. It is a click-to-expand disclosure. Use a tooltip for brief text that appears on hover or keyboard focus. Put longer explanations in a callout or a linked page.

Syntax

Give the disclosure a visible label and one short plain-text definition.

<InfoHint label="Canonical URL">
The preferred address for a page when several addresses show the same content.
</InfoHint>
Canonical URL

The preferred address for a page when several addresses show the same content.

Attribute Required Meaning
label Yes Nonempty text shown on the disclosure control.

<InfoHint> must be a block element with one plain-text definition. It does not accept links, multiple paragraphs, or other components inside the definition.

<Tooltip> previously named this same disclosure. Use <InfoHint> to keep click-to-expand behavior; <Tooltip> now provides hover and focus behavior.

HTML, Markdown, and agents

HTML uses native <details> and <summary> elements. Readers can open the definition with a click, tap, Enter, or Space without JavaScript. The definition is present in the initial HTML even while the disclosure is closed.

Markdown writes the label and definition together in ordinary text. An agent can read the explanation without opening a disclosure.

  • Callouts — Choose a short optional definition or an explanation visible in the reading path.
  • Keyboard shortcuts — Use key styling for shortcuts and a disclosure for optional definitions.

Often confused with

  • Collapsibles — A short definition contains plain text; a collapsible holds longer rich content.
  • Tooltips — Tooltips open on hover or focus; short definitions use native click-to-expand disclosures.