Add Astro Starlight links validator extension and fix broken documentation links - #758
Merged
Merged
Conversation
…s.md documentation Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…validation Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add Astro starlight links validator extension to docs, fix broken links in docs
Add Astro Starlight links validator extension and fix broken documentation links
Sep 12, 2025
pelikhan
approved these changes
Sep 12, 2025
pelikhan
marked this pull request as ready for review
September 12, 2025 03:39
pelikhan
deleted the
copilot/fix-5112b47c-b8b9-4c43-9ff1-5590bc6fb907
branch
September 12, 2025 03:41
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.
This PR addresses broken links in the documentation by implementing automated link validation using the
starlight-links-validatorplugin for Astro Starlight.Problem
The documentation had several issues:
alias-triggers.mdfile referenced throughout the docsSolution
1. Added Starlight Links Validator Plugin
starlight-links-validator@0.17.2as a dependencyastro.config.mjswith appropriate settings:2. Created Missing Documentation
Added comprehensive
docs/src/content/docs/reference/alias-triggers.mdcovering:/command-namesyntax)${{ needs.task.outputs.text }}3. Enhanced Build Process
validate-linksnpm script for standalone link validationValidation
The implementation successfully validates all documentation links:
Testing
The validator was tested to ensure it:
[text](file.md))[text](/missing/path/))This ensures robust documentation link integrity going forward while maintaining the existing Starlight link conventions.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
api.contoso.com/tmp/go-build3450889066/b278/cli.test -test.testlogfile=/tmp/go-build3450889066/b278/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true(dns block)telemetry.astro.buildnode /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.