docs(snippets): replace HTML comments with JSX comments for strict MDX compatibility#11117
Merged
anakin87 merged 1 commit intodeepset-ai:mainfrom Apr 16, 2026
Merged
Conversation
…mpatibility
Replace all `<!-- test-ignore -->` HTML comment markers in Python docstrings
and generated API reference docs with JSX comments `{/* test-ignore */}` to be
compatible with strict MDX parsing in Docusaurus v4.
Also update test_python_snippets.py to use the new JSX marker format for
`TEST_IGNORE_MARK`, `TEST_CONCEPT_MARK`, `TEST_RUN_MARK`, and
`TEST_REQUIRE_FILES_PREFIX` constants, and remove the `mdx1Compat: { comments: true }`
compatibility setting from docusaurus.config.js.
Closes deepset-ai#11104
|
@Aftabbs is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
anakin87
added
the
ignore-for-release-notes
anakin87
added a commit
that referenced
this pull request
Apr 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Closes #11104.
Replaces all
<!-- test-ignore -->HTML comment markers in Python docstrings and generated API reference docs with JSX comments{/* test-ignore */}to be compatible with strict MDX parsing in Docusaurus v4.Changes:
haystack/**/*.py(31 files):<!-- test-ignore -->→{/* test-ignore */}in docstring usage examplesdocs-website/reference/haystack-api/*.md(13 files): same replacement in generated API reference docsdocs-website/scripts/test_python_snippets.py: updateTEST_IGNORE_MARK,TEST_CONCEPT_MARK,TEST_RUN_MARK,TEST_REQUIRE_FILES_PREFIXconstants + detection logic (startswith/endswithchecks) + docstring examplesdocs-website/docusaurus.config.js: removemdx1Compat: { comments: true }compatibility shimAfter this change the docs site can run with strict MDX and the
mdx1Compat.commentsworkaround is no longer needed.Before submitting
Testing
The
test_python_snippets.pyscript will correctly detect the new JSX marker format since all constants and detection logic have been updated consistently.