Skip to content

Adds link to beta docs#8998

Open
bmuenzenmeyer wants to merge 3 commits into
mainfrom
beta-docs
Open

Adds link to beta docs#8998
bmuenzenmeyer wants to merge 3 commits into
mainfrom
beta-docs

Conversation

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

Description

Good feedback within nodejs/node#62045 has mentioned that despite social media posts and github issues, most users may have not yet seen the beta docs. To expand an ever-increasing feedback gathering campaign, I think we should publicize the beta docs on par with the official docs.

Unsure if this has been proposed before - apologies if I missed it.

Large Light/Dark
image
image

Mobile
image

Validation

  • View docs next to current.
  • Should open in new tab

Related Issues

nodejs/node#62045

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run pnpm format to ensure the code follows the style guide.
  • I have run pnpm test to check if all tests are passing.
  • I have run pnpm build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

Copilot AI review requested due to automatic review settings July 5, 2026 01:19
@bmuenzenmeyer bmuenzenmeyer requested a review from a team as a code owner July 5, 2026 01:19
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
nodejs-org Ready Ready Preview Jul 5, 2026 2:11am

Request Review

@cursor

cursor Bot commented Jul 5, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Navigation and presentation-only changes with no auth, data, or security impact.

Overview
Adds a Beta Docs item to the main navbar (next to official Docs), linking to https://beta.docs.nodejs.org/ in a new tab to surface the beta documentation site.

Introduces an optional accent flag on nav entries and wires it through site navigation → NavBarNavItem, with new light/dark brand highlight styles so the Beta Docs link stands out. English copy "Beta Docs" is added; e2e locale checks skip this link when verifying translated nav labels because it stays English on non-English locales.

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

@codecov

codecov Bot commented Jul 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.43%. Comparing base (a5b11b7) to head (9ce9781).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8998      +/-   ##
==========================================
+ Coverage   75.39%   75.43%   +0.04%     
==========================================
  Files          98       98              
  Lines        8636     8642       +6     
  Branches      318      318              
==========================================
+ Hits         6511     6519       +8     
+ Misses       2121     2119       -2     
  Partials        4        4              

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

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

if we dont like the accent approach and how much it drills through the schema and makes file changes - we could try to key the styling entirely off of the URL value - which would be less intrusive long-term, but sorta brittle

Comment thread apps/site/navigation.json

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “Beta Docs” entry to the site’s top navigation and introduces an “accent” styling option so the beta docs link can be visually highlighted alongside existing nav items.

Changes:

  • Add a new betaDocs navigation entry (label + URL + _blank target) and wire it through the site navigation mapping/types.
  • Add an accent boolean prop to NavItem/NavBar and implement the corresponding CSS module styling.
  • Update Storybook to showcase the new “Beta Docs” nav item.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/ui-components/src/Containers/NavBar/NavItem/index.tsx Adds accent prop support when rendering nav links.
packages/ui-components/src/Containers/NavBar/NavItem/index.module.css Introduces the .accent visual style for highlighted nav items.
packages/ui-components/src/Containers/NavBar/index.tsx Threads accent through NavBarNavItem rendering.
packages/ui-components/src/Containers/NavBar/index.stories.tsx Demonstrates the new “Beta Docs” item and accent styling in Storybook.
packages/i18n/src/locales/en.json Adds the betaDocs navbar link label for English.
apps/site/types/navigation.ts Extends navigation types to include betaDocs and optional accent.
apps/site/navigation.json Adds the betaDocs top navigation entry (external link, _blank, accented).
apps/site/hooks/useSiteNavigation.ts Maps the new accent field through the navigation hook.
apps/site/components/withNavBar.tsx Passes accent through when constructing NavBar items.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/ui-components/src/Containers/NavBar/NavItem/index.tsx
Comment thread packages/i18n/src/locales/en.json
@bmuenzenmeyer

Copy link
Copy Markdown
Contributor Author

both AI bots are too ill-informed to know how we translate based on en.json only - i'd be game to turn off cursor entirely

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor Author

lol those functional tests are really banking on this being up to date in crowdin. brittle

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit c1a02eb. Configure here.

Comment thread apps/site/tests/e2e/general-behavior.spec.ts Outdated
@AugustinMauroy

Copy link
Copy Markdown
Member

okay 2l point:

  • we should add small blog post to say "hey we are working on this ... it's beta so link will disapear"
  • on the beta doc we didn't say where to report issue

So in overall I think most user will not get what happened

@AugustinMauroy

Copy link
Copy Markdown
Member

about accent I found that cool but with current style it's confusing with active

so In my opinion we play with an hover effect

dark:bg-brand-600/15
dark:ring-brand-400/20
ring-1
ring-inset;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add small transition because now on hover it's pass from something transparent to solid instantly

@avivkeller

Copy link
Copy Markdown
Member

I'm not sure how i feel about this. The beta docs aren't 1:1 with the new docs, and only serve as a visual preview of the latest main changes from node, and this gives the impression that they are 1:1, no?

@araujogui araujogui left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

maybe should we start with a announcement banner only first?

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.

5 participants