docs: use RFC 2606 reserved domains across all documentation#4961
Closed
claw-explorer wants to merge 1 commit into
Closed
docs: use RFC 2606 reserved domains across all documentation#4961claw-explorer wants to merge 1 commit into
claw-explorer wants to merge 1 commit into
Conversation
Replace non-reserved domain names with RFC 2606 reserved domains in all documentation files: - example.com → service.example - example.org → service.example - mysite.com → mysite.example - secure.endpoint.com → secure.endpoint.example - test.com → test.example - testing.com → testing.example - example-1.com → example-1.example - example-2.com → example-2.example Follows the convention established in nodejs#4873 (Dispatcher.md). Intentionally preserves references to real services used in examples (jsonplaceholder.typicode.com, echo.websocket.org) and external documentation links. Updated files: - Dispatcher.md (mysite.com references) - GlobalInstallation.md - MockAgent.md - MockPool.md - ProxyAgent.md - RetryAgent.md - SnapshotAgent.md - Socks5ProxyAgent.md - best-practices/crawling.md - best-practices/undici-vs-builtin-fetch.md Ref: https://datatracker.ietf.org/doc/html/rfc2606 Partially addresses nodejs#4866
Member
|
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
2 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.
Summary
Replaces non-reserved domain names with RFC 2606 reserved
.exampleTLD domains across all remaining documentation files, following the convention established in #4873.Changes
example.comservice.exampleexample.orgservice.examplemysite.commysite.examplesecure.endpoint.comsecure.endpoint.exampletest.comtest.exampletesting.comtesting.exampleexample-1.comexample-1.exampleexample-2.comexample-2.exampleUpdated files (10)
Dispatcher.md—mysite.comheader examplesGlobalInstallation.md— fetch/WebSocket/EventSource examplesMockAgent.md— mock intercept/enableNetConnect examplesMockPool.md— mock pool host headersProxyAgent.md— proxy fetch examplesRetryAgent.md— retry origin exampleSnapshotAgent.md— snapshot API examplesSocks5ProxyAgent.md— SOCKS5 proxy examplesbest-practices/crawling.md— crawling examplebest-practices/undici-vs-builtin-fetch.md— comparison examplesPreserved as-is
jsonplaceholder.typicode.com— real API used for live examplesecho.websocket.org— real WebSocket echo servicePartially addresses #4866.