ci: add docs discovery health check#1755
Open
omarespejel wants to merge 6 commits intostarknet-io:mainfrom
Open
ci: add docs discovery health check#1755omarespejel wants to merge 6 commits intostarknet-io:mainfrom
omarespejel wants to merge 6 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 health check for the public
docs.starknet.iodiscovery surface used by agents, crawlers, and developer tools.This complements the existing local
llms.txtvalidator. The local validator checks repository format and link integrity; this workflow checks that the deployed docs site still exposes the expected discovery endpoints and headers after build, hosting, CDN, or platform changes.What This Prevents
Examples of regressions this should catch:
llms.txtorllms-full.txtstops being served after a docs platform or Mintlify config change..well-known/llms.txtor.well-known/llms-full.txtdisappears even though the root files still exist.robots.txtis regenerated without the docs sitemap reference.llms.txtandllms-full.txtlocations.HEAD /or flattens repeatedLinkheaders in a way that affects discovery.What This Checks
https://docs.starknet.io/llms.txthttps://docs.starknet.io/llms-full.txthttps://docs.starknet.io/.well-known/llms.txthttps://docs.starknet.io/.well-known/llms-full.txthttps://docs.starknet.io/sitemap.xmlhttps://docs.starknet.io/robots.txtLinkwithrel="llms-txt"Linkwithrel="llms-full-txt"x-llms-txt: /llms.txtWorkflow Behavior
workflow_dispatchThe checker includes bounded retries, retryable HTTP status handling, a job timeout, multi-value header support, origin-only
--base-urlvalidation, and a GET fallback whenHEAD /is unsupported.Validation
Ran locally:
Both pass.