Fix TypeDoc code span entity rendering#925
Merged
Merged
Conversation
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
hrischuk-da
approved these changes
Jul 1, 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.
Summary
Fixes the TypeDoc renderer so TypeScript syntax inside generated Markdown code spans is emitted as literal code instead of pre-escaped HTML entities.
This addresses the generated-output side of the problem seen in #895 / #875: Mintlify does not decode entities inside inline code spans, so generated forms like
Promise<ConnectResult>render incorrectly. Prose/table summary text still goes through MDX-safe HTML escaping.Changes
<,>,&, and=>in generated TypeScript code spans while still escaping table pipes/backticks.@daml/types, Wallet SDK, and dApp SDK.Validation
direnv exec . python3 -m pytest tests/test_typedoc.py tests/test_typescript_bindings_reference.pydirenv exec . npm run generate:typescript-bindings-reference<,>,=>, or&inside inline code spans in generated TypeScript reference pagesdirenv exec . python3 -m py_compile src/x2mdx/typedoc/render.py scripts/generate_typescript_bindings_reference.pygit diff --checkLocal
npx mint validatewas attempted throughdirenv exec; it remained spinner-only for several minutes and was stopped. The PR CI should run the same Mintlify validation.