mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-06 22:24:02 -05:00
c088d4ed42
This workflow prevents the links that are broken or 404 errors by checking the documentation links during development and before merging into the main code base. This ensures all project documentation (Readme , contribution files) remains current and functional , proactively addressing technical debt. Please note this is a resubmission of a previous [PR](https://github.com/googleapis/genai-toolbox/pull/1756) that was closed due to merge conflicts --------- Co-authored-by: Twisha Bansal <58483338+twishabansal@users.noreply.github.com>
45 lines
1.5 KiB
Plaintext
45 lines
1.5 KiB
Plaintext
# Ignore documentation placeholders and generic example domains
|
|
^https?://([a-zA-Z0-9-]+\.)?example\.com(:\d+)?(/.*)?$
|
|
^http://example\.net
|
|
|
|
# Shields.io badges often trigger rate limits or intermittent 503s
|
|
^https://img\.shields\.io/.*
|
|
|
|
# PDF files are ignored as lychee cannot reliably parse internal PDF links
|
|
\.pdf$
|
|
|
|
# Standard mailto: protocol is not a web URL
|
|
^mailto:
|
|
|
|
# Ignore local development endpoints that won't resolve in CI/CD environments
|
|
^https?://(127\.0\.0\.1|localhost)(:\d+)?(/.*)?$
|
|
|
|
# Placeholder for Google Cloud Run service discovery
|
|
https://cloud-run-url.app/
|
|
|
|
# DGraph Cloud and private instance endpoints
|
|
https://xxx.cloud.dgraph.io/
|
|
https://cloud.dgraph.io/login
|
|
https://dgraph.io/docs
|
|
|
|
# MySQL Community downloads and main site (often protected by bot mitigation)
|
|
https://dev.mysql.com/downloads/installer/
|
|
https://www.mysql.com/
|
|
|
|
# Claude desktop download link
|
|
https://claude.ai/download
|
|
|
|
# Google Cloud Run product page
|
|
https://cloud.google.com/run
|
|
|
|
# These specific deep links are known to cause redirect loops or 403s in automated scrapers
|
|
https://dev.mysql.com/doc/refman/8.4/en/sql-prepared-statements.html
|
|
https://dev.mysql.com/doc/refman/8.4/en/user-names.html
|
|
|
|
# npmjs links can occasionally trigger rate limiting during high-frequency CI builds
|
|
https://www.npmjs.com/package/@toolbox-sdk/core
|
|
https://www.npmjs.com/package/@toolbox-sdk/adk
|
|
|
|
|
|
# Ignore social media and blog profiles to reduce external request overhead
|
|
https://medium.com/@mcp_toolbox |