CTA

The CTA (call-to-action) feature renders a card in the right-hand sidebar of a page, with a button and a short list of benefits. By default, every page shows the built-in trial card. Docsets can define their own named CTA templates and have individual pages opt into them.

Add a cta map to your docset.yml file. Each key is a template name; the value defines the button and benefits.

cta:
  beta:
    button:
      label: Join the private beta
      url: https://example.com/beta-signup
    benefits:
      - "Early access to new features"
      - "Direct line to the team"
      - "Free for beta participants"
		

• button.label and button.url are required.
• benefits is optional and limited to 3 entries.

You can also override the built-in default by defining your own trial entry — it replaces the default card sitewide for this docset.

Use the cta frontmatter field to select a template by id:

---
cta:
  id: beta
---
		

If a page omits cta, or its id doesn't match a template defined in docset.yml, it falls back to the built-in trial CTA. An unknown id also emits a build warning.

CTA buttons are tracked via OpenTelemetry: a cta_viewed event fires the first time a card becomes visible, and a cta_clicked event fires on click. Both events carry the CTA's name, URL, label, and placement, so click-through rate can be compared across templates.