Add linkspector CI action

[StephenButtolph]

Why this should be merged

We currently have a number of broken links:

┌───────────────────────────────┬────────┐
│ 🟰 Total files checked        │     44 │
├───────────────────────────────┼────────┤
│ 🔗 Total links checked        │    241 │
├───────────────────────────────┼────────┤
│ 🌐 Hyperlinks                 │    119 │
├───────────────────────────────┼────────┤
│ 📁 File and header links      │    120 │
├───────────────────────────────┼────────┤
│ ✉️  Email links (Skipped)     │      2 │
├───────────────────────────────┼────────┤
│ ✅ Working links              │    223 │
├───────────────────────────────┼────────┤
│ 🚫 Failed links               │     16 │
└───────────────────────────────┴────────┘

How this works

1. Fixes all broken links
2. Adds link checking to CI

After merging this action will NOT become required, as sometimes the external websites are flaky.

How this was tested

Running linkspector check -s locally. (After this PR, the action behavior will need to be validated)
Can be installed locally with npm install -g @umbrelladocs/linkspector

Need to be documented in RELEASES.md?

No.

[meaghanfitzgerald]

The linter is falsely rejecting https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md in api/metrics/service.md. Might be due to the filename ending?

[meaghanfitzgerald]

Link to prometheus repo fails no matter where I link within the repo

[StephenButtolph]

The linter is falsely rejecting https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md in api/metrics/service.md. Might be due to the filename ending?

It was reporting 429 (rate limited) so I had assumed locally it was because I had just hit it too many time locally... Seems like github has some aggressive RL... Switched to the (probably better) hosted rendering of the doc.

[meaghanfitzgerald]

it failed to format it's own output correctly 🫠

[StephenButtolph]

it failed to format it's own output correctly 🫠

I care more about the ✅ and ❌. But yeah I noticed that as well haha, if you want to contribute to open source, seems like some low hanging fruit haha

[Copilot]

Pull Request Overview

This PR adds a new CI action for link checking using linkspector, while also updating various documentation links and file paths to reflect recent restructurings.

• Update README and related docs to reference new paths and packages
• Fix typos and adjust link anchors for consistency
• Introduce a new CI workflow for link linting

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
vms/example/xsvm/README.md	Updated package and link references to use the new interchain messaging.
tests/fixture/e2e/describe.go	Fixed a spelling mistake in a comment.
tests/e2e/README.md	Adjusted file path references; updated link anchor (potential issue).
tests/antithesis/README.md	Updated Antithesis documentation link.
snow/README.md	Changed absolute links to relative links for networking components.
genesis/README.md	Updated genesis file link to a relative path.
config/config.md	Updated genesis documentation links.
api/metrics/service.md	Updated Prometheus documentation link.
README.md	Modified link anchor for autogenerated mocks section (potential issue).
.linkspector.yml	Added configuration for link checking, excluding specific files/patterns.
.github/workflows/ci.yml	Added a new CI job for markdown links linting via linkspector.

[maru-ava]

Do we want to be able to check this locally without an action?

[StephenButtolph]

The readme here talks about how to run it locally: https://github.com/UmbrellaDocs/linkspector. I found it useful to run locally. Would we want this added as a task + nix dep?

[maru-ava]

Task + nix dep sounds good.