Enhance `check_doc_links` script to verify links in YAML files - Githubissues

machine-learning-exchange / katalog

MLX Katalog is a project to hold the default content samples to bootstrap Machine Learning eXchange.

Apache License 2.0

12 stars 13 forks source link

Enhance `check_doc_links` script to verify links in YAML files #43

Closed ckadner closed 3 years ago

ckadner commented 3 years ago

All too often there are typos in links or links run out of date. This is especially bad when MLX requires the URL to load resources like:

related assets
readme_url

A script for this already exists: https://github.com/machine-learning-exchange/katalog/blob/main/tools/python/verify_doc_links.py

And the change to include YAML files is similar to the script in the mlx repo which included JSON files: https://github.com/machine-learning-exchange/mlx/blob/20c66c092d1775cc15de2af906c835f0c4e066c1/tools/python/verify_doc_links.py#L34