docs(web): document remoteConfigUrl in web generator README#899
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryLow Risk Overview Adds a row to the Configuring table (type 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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
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>
c16181c to
8831c1b
Compare
Closes #898
Problem
remoteConfigUrlis a realwebgenerator config option (default'https://nodejs.org/site.json', set insrc/generators/web/index.mjs), exposed via the#theme/configvirtual module, and consumed byRemoteLoadableBanner.jsx→loadBanners.mjsto fetch announcement banner data. It was undocumented insrc/generators/web/README.md.Change
Added
remoteConfigUrlto both tables it was missing from:#theme/configAvailable exports table.Docs only, no behavior change — matches the note in CONTRIBUTING.md that internal-docs-only changes don't need a changeset.