Skip to content

docs: admonitions right usage#11063

Merged
anakin87 merged 6 commits intodeepset-ai:mainfrom
srini047:admonitions-right-usage
Apr 9, 2026
Merged

docs: admonitions right usage#11063
anakin87 merged 6 commits intodeepset-ai:mainfrom
srini047:admonitions-right-usage

Conversation

@srini047
Copy link
Copy Markdown
Contributor

@srini047 srini047 commented Apr 9, 2026

Related Issues

Proposed Changes:

Currently across haystack docs website we have this syntax for admonitions:

:::<admonition_name> <abc>

From docusaurus 3.10 it isn't supported: https://docusaurus.io/blog/releases/3.10#strict-admonitions
Right syntax is:

:::<admonition_name>
<abc>

How did you test it?

Check places currently not rendered properly with the changes.

Notes for the reviewer

@anakin87 Please help with review of the update PR.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have 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 have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@srini047 srini047 requested review from a team as code owners April 9, 2026 09:01
@srini047 srini047 requested review from bogdankostic and removed request for a team April 9, 2026 09:01
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 9, 2026

@srini047 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@anakin87 anakin87 requested review from anakin87 and removed request for bogdankostic April 9, 2026 09:01
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 9, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Apr 9, 2026 9:04am

Request Review

Copy link
Copy Markdown
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thank you!

@anakin87 anakin87 merged commit 46dfbd5 into deepset-ai:main Apr 9, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tip and Note tags malformed in Document Stores doc page

2 participants