docs: update docs #5317
docs: update docs #5317
Conversation
WalkthroughThe recent updates primarily focus on improving the documentation by refining reference links. In the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (2)
site/docs/advanced/loader.zh-CN.md (2)
Line range hint
284-284: Correct the link fragment for better navigation.- [caseStyle](#caseStyle-string) + [caseStyle](#casestyle-string)
Line range hint
392-392: Correct the link fragment for better navigation.- [LoaderOptions](#LoaderOptions) + [LoaderOptions](#loaderoptions)
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- site/docs/advanced/loader.md (1 hunks)
- site/docs/advanced/loader.zh-CN.md (1 hunks)
- site/docs/core/httpclient.md (1 hunks)
- site/docs/core/httpclient.zh-CN.md (1 hunks)
Additional Context Used
Markdownlint (68)
site/docs/advanced/loader.md (15)
539: Expected: 1; Actual: 2
Multiple consecutive blank lines
534: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
534: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
533: null
Fenced code blocks should be surrounded by blank lines
535: null
Lists should be surrounded by blank lines
80: null
Fenced code blocks should have a language specified
98: null
Fenced code blocks should have a language specified
145: null
Fenced code blocks should have a language specified
156: null
Fenced code blocks should have a language specified
247: null
Images should have alternate text (alt text)
280: Expected: #casestyle-string; Actual: #caseStyle-string
Link fragments should be valid
390: Expected: #loaderoptions; Actual: #LoaderOptions
Link fragments should be valid
126: Expected: 4; Actual: 3; Too few cells, row will be missing data
Table column count
127: Expected: 4; Actual: 3; Too few cells, row will be missing data
Table column count
134: Expected: 4; Actual: 3; Too few cells, row will be missing data
Table column countsite/docs/advanced/loader.zh-CN.md (19)
502: Expected: 1; Actual: 2
Multiple consecutive blank lines
93: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
191: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
285: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
351: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
423: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
92: null
Fenced code blocks should be surrounded by blank lines
190: null
Lists should be surrounded by blank lines
462: null
Lists should be surrounded by blank lines
479: null
Lists should be surrounded by blank lines
538: null
Lists should be surrounded by blank lines
80: null
Fenced code blocks should have a language specified
97: null
Fenced code blocks should have a language specified
150: null
Fenced code blocks should have a language specified
161: null
Fenced code blocks should have a language specified
251: null
Images should have alternate text (alt text)
540: null
Files should end with a single newline character
284: Expected: #casestyle-string; Actual: #caseStyle-string
Link fragments should be valid
392: Expected: #loaderoptions; Actual: #LoaderOptions
Link fragments should be validsite/docs/core/httpclient.md (5)
800: Expected: 1; Actual: 2
Multiple consecutive blank lines
707: null
Dollar signs used before commands without showing output
802: null
Lists should be surrounded by blank lines
62: null
Bare URL used
588: null
Spaces inside code span elementssite/docs/core/httpclient.zh-CN.md (29)
692: null
Dollar signs used before commands without showing output
55: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
166: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
268: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
384: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
500: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
624: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
699: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
704: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
709: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
714: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
719: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
724: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
728: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
54: null
Fenced code blocks should be surrounded by blank lines
165: null
Fenced code blocks should be surrounded by blank lines
267: null
Fenced code blocks should be surrounded by blank lines
383: null
Fenced code blocks should be surrounded by blank lines
499: null
Fenced code blocks should be surrounded by blank lines
639: null
Lists should be surrounded by blank lines
700: null
Lists should be surrounded by blank lines
705: null
Lists should be surrounded by blank lines
710: null
Lists should be surrounded by blank lines
715: null
Lists should be surrounded by blank lines
720: null
Lists should be surrounded by blank lines
725: null
Lists should be surrounded by blank lines
727: null
Lists should be surrounded by blank lines
779: null
Lists should be surrounded by blank lines
733: null
Fenced code blocks should have a language specified
Additional comments not posted (1)
site/docs/advanced/loader.zh-CN.md (1)
538-540: Ensure that the hyperlinks are correctly formatted and accessible.Verification successful
The hyperlinks in the documentation are correctly formatted and accessible.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the hyperlinks. # Test: Check if the URLs are accessible. Expect: HTTP 200 OK responses. curl -o /dev/null -s -w "%{http_code}\n" https://github.com/eggjs/egg-core/blob/master/lib/loader/egg_loader.js curl -o /dev/null -s -w "%{http_code}\n" https://github.com/eggjs/egg/blob/master/lib/loader/app_worker_loader.js curl -o /dev/null -s -w "%{http_code}\n" https://github.com/eggjs/egg/blob/master/lib/loader/agent_worker_loader.jsLength of output: 359
| - [urllib](https://github.com/node-modules/urllib) | ||
| - [httpclient](https://github.com/eggjs/egg/blob/master/lib/core/httpclient.js) | ||
| - [formstream](https://github.com/node-modules/formstream) | ||
| - [http](https://nodejs.org/api/http.html) | ||
| - [https](https://nodejs.org/api/https.html) | ||
| - [charles](https://www.charlesproxy.com/) | ||
| - [fiddler](http://www.telerik.com/fiddler) |
There was a problem hiding this comment.
Tip
Codebase Verification
The verification script has confirmed that all the URLs are accessible and correctly formatted, except for the last URL (http://www.telerik.com/fiddler), which returned an HTTP 301 status code, indicating it has been moved permanently. This suggests that the URL should be updated to its new location.
- http://www.telerik.com/fiddler returned HTTP 301 Moved Permanently.
Analysis chain
Ensure that the hyperlinks are correctly formatted and accessible.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the accessibility of the hyperlinks.
# Test: Check if the URLs are accessible. Expect: HTTP 200 OK responses.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/node-modules/urllib
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/eggjs/egg/blob/master/lib/core/httpclient.js
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/node-modules/formstream
curl -o /dev/null -s -w "%{http_code}\n" https://nodejs.org/api/http.html
curl -o /dev/null -s -w "%{http_code}\n" https://nodejs.org/api/https.html
curl -o /dev/null -s -w "%{http_code}\n" https://www.charlesproxy.com/
curl -o /dev/null -s -w "%{http_code}\n" http://www.telerik.com/fiddler
Length of output: 602
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5317 +/- ##
=======================================
Coverage 99.86% 99.86%
=======================================
Files 36 36
Lines 3620 3628 +8
Branches 519 520 +1
=======================================
+ Hits 3615 3623 +8
Misses 5 5 ☔ View full report in Codecov by Sentry. |
Description of change
update document link display error
fixs #5318
Summary by CodeRabbit