Docs: Fix dead links and invalid hashes #1356
Open
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.
Description
I've spotted a dead link while browsing the documentation, and since I knew that you're using Starlight, I tried to install and execute starlight-links-validator.
The primary goal of this PR is to fix the dead links and invalid hashes, but it also includes a possible enhancement for the project by using
starlight-links-validator
.Installing
starlight-links-validator
The first commit of this PR (8726ef1) shows how to install
starlight-links-validator
.starlight-links-validator
, there will be a fix to do in this PR as I had to comment a line indocs/src/remark-playground.ts
. I haven't especially tried to fix this properly, I preferred to know before whether you would like to includestarlight-links-validator
in your build :)Fix dead links and invalid hashes in the doc
Here's the output of running
npm run docs:build
withstarlight-links-validator
enabled in the project:Based on these results, I tried to find the correct target URLs in b672395. Hope I haven't made too many mistakes 😬
Fix invalid hashes in the library
Finally, one of these invalid hashes was also in the comments of the library, so has been fixed along the way via 94e3a38.
Final words
In the end, this PR gathers different elements.
Based on your feedback, I can remove/modify the commits, or split the PR.
Please note that I haven't added any changesets, waiting for a first feedback on how to proceed :)
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.