docs: fix remaining broken links in API documentation#5342
Open
AliMahmoudDev wants to merge 1 commit into
Open
docs: fix remaining broken links in API documentation#5342AliMahmoudDev wants to merge 1 commit into
AliMahmoudDev wants to merge 1 commit into
Conversation
Fixes nodejs#3322 Several previous PRs (nodejs#3807, nodejs#3820, nodejs#5065) fixed many broken links in the Docsify-based documentation, but a number of relative links remained that resolve incorrectly on the live site. Changes: - Pool.md: PoolStats.md -> /docs/docs/api/PoolStats.md - RoundRobinPool.md: PoolStats.md -> /docs/docs/api/PoolStats.md - MockCallHistory.md: ./MockCallHistoryLog.md#to-string -> /docs/docs/api/MockCallHistoryLog.md#to-string - SnapshotAgent.md: 3 relative links -> absolute /docs/docs/api/ and /docs/docs/best-practices/ paths - api-lifecycle.md: 7 Client.md relative links -> /docs/docs/api/Client.md - Dispatcher.md: Dispatch.md -> /docs/docs/api/Dispatcher.md - Fetch.md: /docs/api/ -> /docs/docs/api/ All links now use the consistent /docs/docs/api/ absolute path pattern established in the previously merged PRs. ## Status - [x] I agree to the Developer Certificate of Origin 1.1 - [x] Documentation fix - [x] Ready for review
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5342 +/- ##
=======================================
Coverage 93.22% 93.23%
=======================================
Files 110 110
Lines 36668 36668
=======================================
+ Hits 34185 34188 +3
+ Misses 2483 2480 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
3 participants
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 relates to...
Fixes #3322
Changes
Bug Fixes
Several previous PRs (#3807, #3820, #5065) fixed many broken links in the Docsify-based documentation, but a number of relative links remained that resolve incorrectly on the live site at undici.nodejs.org.
The following broken links were fixed across 7 files:
Pool.md[PoolStats](PoolStats.md)[PoolStats](/docs/docs/api/PoolStats.md)RoundRobinPool.md[PoolStats](PoolStats.md)[PoolStats](/docs/docs/api/PoolStats.md)MockCallHistory.md[see](./MockCallHistoryLog.md#to-string)[see](/docs/docs/api/MockCallHistoryLog.md#to-string)SnapshotAgent.md[MockAgent](./MockAgent.md)[MockAgent](/docs/docs/api/MockAgent.md)SnapshotAgent.md[MockCallHistory](./MockCallHistory.md)[MockCallHistory](/docs/docs/api/MockCallHistory.md)SnapshotAgent.md[Testing](../best-practices/writing-tests.md)[Testing](/docs/docs/best-practices/writing-tests.md)api-lifecycle.md[Client.*](Client.md#...)[Client.*](/docs/docs/api/Client.md#...)Dispatcher.md[Example 2](/docs/docs/api/Dispatch.md#...)[Example 2](/docs/docs/api/Dispatcher.md#...)Fetch.md[install()](/docs/api/GlobalInstallation.md)[install()](/docs/docs/api/GlobalInstallation.md)All links now use the consistent
/docs/docs/api/absolute path pattern established in the previously merged PRs.Status