style: fix admonition headings

[dfokina]

Proposed Changes:

• Fixing admonitions (callouts) to have properly worded headings instead of admonition type, for versions 2.19 and 2.20
• Some examples:
  OLD:

NEW: ------------------------------------------------------------------------------------------------------------------------

OLD:

NEW:

How did you test it?

Builds without errors

Notes for the reviewer

Checklist

• I have read the contributors guidelines and the code of conduct
• I have updated the related issue with new insights and changes
• I added unit tests and updated the docstrings
• I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
• I documented my code
• I ran pre-commit hooks and fixed any issue

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
haystack-docs	Ready	Preview	Comment	Nov 3, 2025 2:49pm

[sjrl]

I noticed in most other cases in the document store mdx that you converted :::info into :::note. Although I can't see any difference between those two in the preview. Is there one we should be using or does it not matter?

[dfokina]

That's a great question @sjrl, essentially the idea is that these three categories have distinct meanings:
:::note - Key details that are important for users to understand (essential information)
:::tip - Optional advice or suggestions that can enhance experience but aren't mandatory
:::info - Useful information that adds value but isn't critical
And your comment made me start looking at concrete examples and finding out discrepancies :) I'll add another commit to standardize the admonition type usage!

[sjrl]

Looks good! One small question about note vs info