fix(scripts): unescape HTML entities in api-reference title checker - #102
Merged
Conversation
The sitemap XML escapes ampersands in URLs (&), and Mintlify renders titles with HTML entities in the h1. Both made the checker report false positives (e.g. the reindex page "Reindex world vector & FTS indexes"). Decode &, <, >, ", and ' when extracting page URLs and rendered titles so the check compares against the plain-text titles. Generated with Codebuff 🤖 Co-Authored-By: Codebuff <noreply@codebuff.com>
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
1 participant
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.
Follow-up to #99/#101: the checker produced false positives on the reindex page because the sitemap XML escapes
&as&in URLs and Mintlify renders&as the&entity in the h1. This decodes&,<,>,", and'when extracting page URLs and rendered titles.Verified:
node scripts/check-api-reference-titles.mjsnow reportsfindings: noneacross all 30 pages (wazoo-api=14, worlds-api=16) and exits 0.