Skip to content

feat: use dynamic config to supply custom beta feedback banner#912

Open
bmuenzenmeyer wants to merge 2 commits into
mainfrom
beta-banner
Open

feat: use dynamic config to supply custom beta feedback banner#912
bmuenzenmeyer wants to merge 2 commits into
mainfrom
beta-banner

Conversation

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

Description

Feedback within nodejs/nodejs.org#8998 (comment) suggested that the beta docs themselves could have a feedback mechanism. To my knowledge, we can do this (once merged to main)

Validation

Upon merge - we should get a custom banner at https://beta.docs.nodejs.org

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run node --run test and all tests passed.
  • I have check code formatting with node --run format & node --run lint.
  • I've covered new added functionality with unit tests if necessary.

@vercel

vercel Bot commented Jul 18, 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 18, 2026 5:43am

Request Review

@bmuenzenmeyer
bmuenzenmeyer marked this pull request as ready for review July 18, 2026 01:04
@bmuenzenmeyer
bmuenzenmeyer requested a review from a team as a code owner July 18, 2026 01:04
@cursor

cursor Bot commented Jul 18, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Build-time config and static banner metadata only; no auth, data, or core doc generation logic changes.

Overview
Adds beta-specific doc-kit configuration so the Vercel build passes --config-file ./beta/doc-kit.config.mjs into generate, wiring the web target to load remote site config from main via remoteConfigUrl.

That remote config is defined in beta/site.json, which sets an index websiteBanners entry (“Give us feedback on the new docs” linking to the doc-kit issues). Banner copy and link can be updated on main without changing the build script, once this is merged and beta deploys use the config.

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

@codecov

codecov Bot commented Jul 18, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.14%. Comparing base (4534824) to head (3503466).

Files with missing lines Patch % Lines
beta/doc-kit.config.mjs 0.00% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #912      +/-   ##
==========================================
- Coverage   86.17%   86.14%   -0.04%     
==========================================
  Files         188      189       +1     
  Lines       17146    17152       +6     
  Branches     1540     1540              
==========================================
  Hits        14776    14776              
- Misses       2363     2369       +6     
  Partials        7        7              

☔ 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.

@github-actions

github-actions Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

api-links Generator

Performance

Metric Base Head Diff
Elapsed time 1.28 s 1.30 s +20.00 ms (+1.56%)
User CPU time 2.75 s 2.80 s +50.00 ms (+1.82%)
System CPU time 340.00 ms 230.00 ms -110.00 ms (-32.35%)
Peak resident memory 348.51 MB 343.66 MB -4.85 MB (-1.39%)

legacy-html Generator

Performance

Metric Base Head Diff
Elapsed time 12.46 s 20.00 s +7.54 s (+60.51%)
User CPU time 39.93 s 64.14 s +24.21 s (+60.63%)
System CPU time 1.60 s 2.48 s +880.00 ms (+55.00%)
Peak resident memory 2.33 GB 2.23 GB -93.02 MB (-3.91%)

legacy-json Generator

Performance

Metric Base Head Diff
Elapsed time 10.23 s 8.83 s -1.40 s (-13.69%)
User CPU time 27.83 s 26.31 s -1.52 s (-5.46%)
System CPU time 2.06 s 1.84 s -220.00 ms (-10.68%)
Peak resident memory 1.69 GB 1.65 GB -43.46 MB (-2.51%)

llms-txt Generator

Performance

Metric Base Head Diff
Elapsed time 7.74 s 8.38 s +640.00 ms (+8.27%)
User CPU time 23.79 s 25.63 s +1.84 s (+7.73%)
System CPU time 1.32 s 2.00 s +680.00 ms (+51.52%)
Peak resident memory 1.57 GB 1.67 GB +102.18 MB (+6.36%)

orama-db Generator

Output size

| File | Base | Head | Diff |

|-|-|-|-|

| orama-db.json | 8.90 MB | 8.89 MB | -1.33 KB (-0.01%) |

Performance

Metric Base Head Diff
Elapsed time 8.38 s 9.35 s +970.00 ms (+11.58%)
User CPU time 23.44 s 26.01 s +2.57 s (+10.96%)
System CPU time 1.44 s 1.94 s +500.00 ms (+34.72%)
Peak resident memory 1.59 GB 1.71 GB +116.12 MB (+7.12%)

web Generator

Output size

| File | Base | Head | Diff |

|-|-|-|-|

| all.html | 21.27 MB | 21.27 MB | -158.00 B (-0.00%) |

Performance

Metric Base Head Diff
Elapsed time 77.88 s 76.74 s -1.14 s (-1.46%)
User CPU time 161.49 s 164.13 s +2.64 s (+1.63%)
System CPU time 4.90 s 5.14 s +240.00 ms (+4.90%)
Peak resident memory 5.59 GB 5.62 GB +33.77 MB (+0.59%)

@avivkeller

Copy link
Copy Markdown
Member

I'd really like if this preview stuff was all in its own directory, so we can remove it when we are done with it

@avivkeller

Copy link
Copy Markdown
Member

btw are the new diff comments too detailed?

@bmuenzenmeyer

bmuenzenmeyer commented Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

btw are the new diff comments too detailed?

on top of being broken markdown tables, perhaps

edit: otherwise, they are fine. we are used to verbose PR output

@avivkeller

Copy link
Copy Markdown
Member

I'll improve them :-)

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor Author

I'd really like if this preview stuff was all in its own directory, so we can remove it when we are done with it

addressed via 3503466

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.

2 participants