Repository navigation
📖🔧:drop the backslashes from generic API titles - #1922
Merged
openinf-commit-queue[bot] merged 1 commit intoOct 19, 2026
Merged
Conversation
TypeDoc escapes Markdown punctuation in its page headings, so the seventeen generic API pages took titles such as `Guard\<T\>` and showed the backslashes in their h1 and <title>. The <title> was also printed unescaped, and the minifier read `<T>` there as a tag, which left a stray </T> in every such page's tab title. Unescape CommonMark backslash escapes when reading the title, and escape the <title> with escape_once so hand-written titles that already carry an entity render as before. A generic type is now covered by the stripTypeDocChrome tests. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5
✅ Deploy Preview for gh-pages-openinf ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
openinf-commit-queue
Bot
deleted the
claude/full-audit-0e491i-sdk-titles
branch
October 19, 2026 12:34
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
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.
Requested by DerekNonGeneric · project thread
Before: with the SDK's real TypeDoc output imported, 17 API pages got titles such as
Type Alias: Guard\<T\>andInterface: MapLike\<T\>, and the backslashes showed in the page heading. The<title>was printed unescaped, and the HTML minifier read<T>there as a tag, so the tab title came out asType Alias: Guard\<T \>· OpenINF</T>.After: those pages are titled
Type Alias: Guard<T>, and the<title>renders asType Alias: Guard<T> · OpenINF.How:
stripTypeDocChromeremoves CommonMark backslash escapes (ASCII punctuation only) from the heading it takes as the title.head.liquidescapes the title withescape_once, so a hand-written title that already contains an entity renders as before. A new test covers a generic type's title, and it fails without the fix. Over the 463 pages TypeDoc generates for the SDK, exactly those 17 titles change. In a full site build with that corpus, exactly those 17 pages differ, and every other page is byte-identical.nps testpasses, apart from three checks that need network access the sandbox does not have (verify-dockerfile, verify-toml and verify-valid-for-ec).Summary by CodeRabbit
<while preserving existing HTML entities.