Skip to content

docs(web): document remoteConfigUrl in web generator README#899

Open
nabsei wants to merge 1 commit into
nodejs:mainfrom
nabsei:docs/document-remote-config-url
Open

docs(web): document remoteConfigUrl in web generator README#899
nabsei wants to merge 1 commit into
nodejs:mainfrom
nabsei:docs/document-remote-config-url

Conversation

@nabsei

@nabsei nabsei commented Jul 11, 2026

Copy link
Copy Markdown

Closes #898

Problem

remoteConfigUrl is a real web generator config option (default 'https://nodejs.org/site.json', set in src/generators/web/index.mjs), exposed via the #theme/config virtual module, and consumed by RemoteLoadableBanner.jsxloadBanners.mjs to fetch announcement banner data. It was undocumented in src/generators/web/README.md.

Change

Added remoteConfigUrl to both tables it was missing from:

  • The Configuring options table (name, type, default, description).
  • The #theme/config Available exports table.

Docs only, no behavior change — matches the note in CONTRIBUTING.md that internal-docs-only changes don't need a changeset.

@nabsei nabsei requested a review from a team as a code owner July 11, 2026 18:36
@vercel

vercel Bot commented Jul 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Jul 12, 2026 8:43am

Request Review

@cursor

cursor Bot commented Jul 11, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
README-only documentation with no code or configuration behavior changes.

Overview
Documents the existing remoteConfigUrl web generator option in src/generators/web/README.md, which was already implemented and exposed via #theme/config but missing from the docs.

Adds a row to the Configuring table (type string, default 'https://nodejs.org/site.json', client-side fetch for remote site config / announcement banners) and a matching row under #theme/config Available exports (ties it to RemoteLoadableBanner). Table column alignment is widened slightly so the new descriptions fit.

Docs only — no runtime or build behavior changes.

Reviewed by Cursor Bugbot for commit 8831c1b. Bugbot is set up for automated code reviews on this repo. Configure here.

@codecov

codecov Bot commented Jul 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.12%. Comparing base (0c53b50) to head (52c29d7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #899   +/-   ##
=======================================
  Coverage   85.12%   85.12%           
=======================================
  Files         180      180           
  Lines       16581    16581           
  Branches     1513     1513           
=======================================
  Hits        14114    14114           
  Misses       2457     2457           
  Partials       10       10           

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

remoteConfigUrl is a real web generator config option (default
'https://nodejs.org/site.json') exposed via #theme/config and consumed
by RemoteLoadableBanner to fetch announcement banner data, but it was
missing from both the Configuring options table and the #theme/config
Available exports table.

No behavior change, docs only.

Closes nodejs#898

Signed-off-by: nabsei <nsahrane@hotmail.com>
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.

remoteConfigUrl is not documented in the web generator README.md

1 participant