ci: add docs metadata health check#1756
Open
omarespejel wants to merge 3 commits intostarknet-io:mainfrom
Open
ci: add docs metadata health check#1756omarespejel wants to merge 3 commits intostarknet-io:mainfrom
omarespejel wants to merge 3 commits intostarknet-io:mainfrom
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.
Summary
Add a lightweight live metadata health check for representative
docs.starknet.iopages.This complements the existing
llms.txtvalidation and discovery endpoint checks. The goal is to catch deployed-site regressions that affect search, AI agents, and social/link previews without burdening normal docs content edits.What This Checks
For key docs pages across homepage, build, protocol, reference, and operations sections, the script checks:
text/htmlresponsenoindexdirective in meta robots orX-Robots-TagMeta descriptions are currently reported as non-blocking warnings because several existing docs pages do not emit them yet. This keeps the check useful without turning existing metadata debt into a blocking gate.
Workflow Behavior
workflow_dispatchExamples Of Regressions This Catches
noindex.Validation
Ran locally:
Staged first in
omarespejel/starknet-docsand addressed AI-review feedback from CodeRabbit and Qodo before opening this upstream PR.