Skip to content

docs(global): use RFC 2606 domains in install examples#4874

Open
nthbotast wants to merge 2 commits intonodejs:mainfrom
nthbotast:docs/global-installation-rfc2606-4866
Open

docs(global): use RFC 2606 domains in install examples#4874
nthbotast wants to merge 2 commits intonodejs:mainfrom
nthbotast:docs/global-installation-rfc2606-4866

Conversation

@nthbotast
Copy link
Contributor

@nthbotast nthbotast commented Mar 8, 2026

What

  • replace .com example domains in docs/docs/api/GlobalInstallation.md with RFC 2606 reserved TLD examples (.example)
  • keep sample intent unchanged while avoiding real-world domains in docs snippets

Why

Validation

  • git diff --check
  • attempted: npx --yes markdownlint-cli2 docs/docs/api/GlobalInstallation.md (fails on pre-existing style issues in this file: MD013/MD060/MD047)

Nathanael BOT added 2 commits March 8, 2026 02:14
Signed-off-by: Nathanael BOT <nathanaelbot@minidenathanael.home>
Signed-off-by: Nathanael BOT <nathanaelbot@minidenathanael.home>
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.02%. Comparing base (fb05ad6) to head (c486748).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4874   +/-   ##
=======================================
  Coverage   93.02%   93.02%           
=======================================
  Files         112      112           
  Lines       35176    35176           
=======================================
+ Hits        32723    32724    +1     
+ Misses       2453     2452    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

// All classes are available globally:
const headers = new Headers([['content-type', 'application/json']])
const request = new Request('https://example.com')
const request = new Request('https://www.example')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something less confusing maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants