Add API docs link checker script and fix broken API links#177
Open
dobromirts wants to merge 2 commits into
Open
Add API docs link checker script and fix broken API links#177dobromirts wants to merge 2 commits into
dobromirts wants to merge 2 commits into
Conversation
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.
How the checker works:
The script scans compiled HTML in the dist/ folder, extracts all staging API URLs, resolves each package to its latest versioned URL, and fetches them concurrently. It distinguishes between HTTP errors (server/network failures) and TypeDoc "NOT FOUND" responses (valid HTTP 200 but missing type/member).
Usage
Build the platform(s) you want to check (both EN and JP are included automatically per platform):
npm run angular:build-staging # builds angular + angular-jp
npm run react:build-staging # builds react + react-jp
Run the checker and generate a Markdown report:
npm run check-api-links:report:angular
npm run check-api-links:report:react
npm run check-api-links:report:blazor
Reports are written to api-link-report-.md in the repo root.