TraceMachina/nativelink

Add link checking to docs

Open

#1,242 opened on Aug 7, 2024

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Rust (222 forks)auto 404
bugenhancementgood first issue

Repository metrics

Stars
 (1,557 stars)
PR merge metrics
 (PR metrics pending)

Description

The current documentation might produce dangling links. Astro and starlight have integrations to automatically check the sanity of links. We should implement this so that we have a systematic way to prevent 404s.

Contributor guide

Research direction
Investigate Astro and Starlight link checking integrations (e.g., @astrojs/check, remark lint) and configure them in the documentation build script.
Tech stack
astronodejshtml
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75