Add script to check documentation links#357
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a repository script to validate StakeWise documentation links and updates existing SDK doc references to the new /sdk/api/... URL structure.
Changes:
- Introduces
scripts/checkDocLinks.jsand wires it intopackage.json+ pre-commit hook. - Updates many
@seedoc links across services to point to/sdk/api/...pages. - Adjusts docs sync script to clone the docs repo into a temp directory.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/services/vault/transactions/index.ts | Updates @see URLs for vault transaction docs (and removes one @see). |
| src/services/vault/requests/getOsTokenConfig/getOsTokenConfig.md | Updates the frontmatter slug to the new docs path. |
| src/services/vault/index.ts | Updates @see URLs for vault request docs. |
| src/services/utils/index.ts | Updates @see URLs for utils request docs. |
| src/services/rewardSplitter/transactions/index.ts | Updates @see URLs for reward splitter transaction docs. |
| src/services/rewardSplitter/index.ts | Updates @see URL for reward splitter request docs. |
| src/services/osToken/transactions/index.ts | Updates @see URLs for osToken transaction docs. |
| src/services/osToken/index.ts | Updates @see URLs for osToken requests/helpers docs. |
| src/services/distributorRewards/transactions/index.ts | Updates @see URL for distributor rewards transaction docs. |
| src/services/distributorRewards/index.ts | Updates @see URL for distributor rewards request docs. |
| src/services/boost/transactions/index.ts | Updates @see URLs for boost transaction docs. |
| src/services/boost/index.ts | Updates @see URLs for boost request docs. |
| scripts/syncDocs/index.ts | Clones docs repo into temp dir and tweaks git usage/cleanup. |
| scripts/checkDocLinks.js | New script that finds docs URLs and validates them against local slugs / live sitemap. |
| package.json | Adds check:docLinks script. |
| .husky/pre-commit | Runs check:docLinks on commit. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 24 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 17 out of 25 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
* Remove sync docs git action (#354) * [remove-sync-docs] remove git action and change script * change git action * add link checker script and update documentation references * fix broken links * add md files to check * small improve * update GitHub Actions to use latest checkout and cache actions (#356) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * add script to check documentation links and update pre-commit hook * update * update * update * add warning for slug changes in staged md files * rename markdown files and update slug checking logic in link checker * Add script to check documentation links (#357) * add script to check documentation links * fix after review * rename documentation files and improve slug validation in checkDocLinks * add category configuration for Quick Start * improve slug processing and include _category_.json in documentation file search * 4.2.3 (#358) * merge --------- Co-authored-by: CAst <programmer.andrey@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Remove sync docs git action (#354) * [remove-sync-docs] remove git action and change script * change git action * update GitHub Actions to use latest checkout and cache actions (#356) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Add script to check documentation links (#357) * add script to check documentation links * fix after review * rename documentation files and improve slug validation in checkDocLinks * add category configuration for Quick Start * improve slug processing and include _category_.json in documentation file search * 4.2.3 (#358) * [fix-encode] fix transactionWrapper (#360) * up-version (#361) * [handle-429] add retry-after header support (#364) * fix --------- Co-authored-by: CAst <programmer.andrey@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Remove sync docs git action (#354) * [remove-sync-docs] remove git action and change script * change git action * update GitHub Actions to use latest checkout and cache actions (#356) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Add script to check documentation links (#357) * add script to check documentation links * fix after review * rename documentation files and improve slug validation in checkDocLinks * add category configuration for Quick Start * improve slug processing and include _category_.json in documentation file search * 4.2.3 (#358) * [fix-encode] fix transactionWrapper (#360) * up-version (#361) * [handle-429] add retry-after header support (#364) * add context7 public key (#370) * remove old files --------- Co-authored-by: Kadyr Dzhemaledinov <dfkadyr@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* add script to check documentation links * fix after review * rename documentation files and improve slug validation in checkDocLinks * add category configuration for Quick Start * improve slug processing and include _category_.json in documentation file search
* Remove sync docs git action (#354) * [remove-sync-docs] remove git action and change script * change git action * Add script to check documentation links (#357) * add script to check documentation links * fix after review * rename documentation files and improve slug validation in checkDocLinks * add category configuration for Quick Start * improve slug processing and include _category_.json in documentation file search * [context7] test Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] test Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context7.json Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update context Signed-off-by: MikeDiam <info@mdiamond.ru> * [context7] update structure Signed-off-by: MikeDiam <info@mdiamond.ru> --------- Signed-off-by: MikeDiam <info@mdiamond.ru> Co-authored-by: CAst <programmer.andrey@gmail.com> Co-authored-by: Kadyr Dzhemaledinov <dfkadyr@gmail.com>
No description provided.