feat: add configuration for nav by avivkeller · Pull Request #964 · nodejs/doc-kit

avivkeller · 2026-07-31T01:22:45Z

Adds web.navigation, which supplies the sidebar groups (navigation.sidebar) and the navigation bar items (navigation.navbar) from configuration. That way, consumers don't need to rewrite the component just to change the nav

cursor · 2026-07-31T01:22:51Z

PR Summary

Low Risk
Additive, backward-compatible web generator configuration with unchanged defaults when navigation is omitted; risk is limited to nav/link resolution behavior on sites that opt in.

Overview
Adds web.navigation so sites can define navigation.sidebar (grouped links with optional nesting) and navigation.navbar (top bar items) in doc-kit.config.mjs instead of overriding #theme/Sidebar / #theme/Navigation.

The built-in SideBar now builds groups from config when present (resolving internal paths per page, passing through http(s) links, supporting nested items); otherwise it keeps the single API Documentation group from pages. The version Select is only rendered when versions is non-empty. NavBar reads navigation.navbar (default empty) and passes pathname={metadata.path} for active highlighting.

navigation is typed against the UI SideBar / NavBar props, defaulted in the web generator, and exported from #theme/config. The doc-kit www site drops its custom sidebar component in favor of config (including a glob-built Generators group); beta adds absolute navbar links for the Node.js preview.

^{Reviewed by Cursor Bugbot for commit 9107b8b. Bugbot is set up for automated code reviews on this repo. Configure here.}

vercel · 2026-07-31T01:22:51Z

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

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Jul 31, 2026 1:23am

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

codecov · 2026-07-31T01:23:43Z

Codecov Report

❌ Patch coverage is 5.76923% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.79%. Comparing base (b80958f) to head (9107b8b).

Files with missing lines	Patch %	Lines
www/doc-kit.config.mjs	0.00%	30 Missing ⚠️
beta/doc-kit.config.mjs	0.00%	19 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #964      +/-   ##
==========================================
+ Coverage   86.63%   86.79%   +0.16%     
==========================================
  Files         195      194       -1     
  Lines       17938    17907      -31     
  Branches     1632     1632              
==========================================
+ Hits        15540    15543       +3     
+ Misses       2392     2358      -34     
  Partials        6        6

☔ 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 · 2026-07-31T01:25:23Z