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.
If you don't want to install it for whatever reason, I can remove this commit. Just wanted to show you how it works.
⚠️ If you'd like to keep starlight-links-validator, there will be a fix to do in this PR as I had to comment a line in docs/src/remark-playground.ts. I haven't especially tried to fix this properly, I preferred to know before whether you would like to include starlight-links-validator in your build :)
Fix dead links and invalid hashes in the doc
Here's the output of running npm run docs:build with starlight-links-validator enabled in the project:
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.
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 (https://github.com/amzn/style-dictionary/commit/8726ef1d6bb27147992dd360746f2caebf007931) 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 https://github.com/amzn/style-dictionary/pull/1356/commits/b672395cea37389cc6254daa968537fb8ecc008f. 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 https://github.com/amzn/style-dictionary/pull/1356/commits/94e3a389f007ddc67423b818b4951121f5d93518.
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.