feat: create beta API docs announcement post#9002
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryLow Risk Overview Registers Guilherme Araújo in Reviewed by Cursor Bugbot for commit 82e7259. 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 #9002 +/- ##
==========================================
- Coverage 74.58% 74.55% -0.04%
==========================================
Files 100 100
Lines 8801 8806 +5
Branches 324 325 +1
==========================================
+ Hits 6564 6565 +1
- Misses 2233 2237 +4
Partials 4 4 ☔ View full report in Codecov by Harness. |
There was a problem hiding this comment.
Pull request overview
Adds a new announcements blog post to publicize the beta Node.js API documentation site and registers the post’s author in the site author registry.
Changes:
- Adds a new announcement post introducing the beta API docs and requesting feedback.
- Adds a new author entry for “Guilherme Araújo” in
authors.json.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| apps/site/pages/en/blog/announcements/new-api-docs-beta.md | New announcement post advertising the beta API docs and linking to feedback channels. |
| apps/site/authors.json | Adds the author metadata needed for the new post’s author frontmatter. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📦 Build Size ComparisonSummary
Changes🔄 Modified Routes (4)
|
|
great work @araujogui !!! |
| The content itself hasn't changed: every page is generated from the same Markdown files in the [nodejs/node](https://github.com/nodejs/node) repository that power the current docs. The features you rely on today made the trip too: light and dark themes, ESM/CJS switching and copy buttons on snippets, stability badges, and version history. | ||
|
|
||
| The redesign goes deeper than visuals, though: navigation, layout, and readability were all reworked so that finding and understanding an API takes less effort. On top of that, the beta adds things the current docs have never had: | ||
|
|
||
| - **Search**: For the first time, the API docs have built-in search. A search box on every page, with a keyboard shortcut, lets you jump anywhere in the API without a detour through a search engine. | ||
| - **One design across the project**: The API docs now share the design system of the nodejs.org website, with a persistent sidebar listing every module, an always-visible per-page table of contents, and a layout that works on small screens. | ||
| - **Docs as Markdown**: Every page can now be viewed as plain Markdown, a format that AI tools like Claude Code and Codex can work with natively. Point them at a page and they can read it as is, with no HTML scraping in between. | ||
|
|
||
| And that's not the whole list: the beta also ships features like reading times, announcement bars, [llms.txt](https://nodejs.org/llms.txt) etc. | ||
|
|
||
| We also care about the needs of every user, and we pay attention to the ones that are easy to overlook. Every page stays usable even with JavaScript disabled and offline. |
There was a problem hiding this comment.
| The content itself hasn't changed: every page is generated from the same Markdown files in the [nodejs/node](https://github.com/nodejs/node) repository that power the current docs. The features you rely on today made the trip too: light and dark themes, ESM/CJS switching and copy buttons on snippets, stability badges, and version history. | |
| The redesign goes deeper than visuals, though: navigation, layout, and readability were all reworked so that finding and understanding an API takes less effort. On top of that, the beta adds things the current docs have never had: | |
| - **Search**: For the first time, the API docs have built-in search. A search box on every page, with a keyboard shortcut, lets you jump anywhere in the API without a detour through a search engine. | |
| - **One design across the project**: The API docs now share the design system of the nodejs.org website, with a persistent sidebar listing every module, an always-visible per-page table of contents, and a layout that works on small screens. | |
| - **Docs as Markdown**: Every page can now be viewed as plain Markdown, a format that AI tools like Claude Code and Codex can work with natively. Point them at a page and they can read it as is, with no HTML scraping in between. | |
| And that's not the whole list: the beta also ships features like reading times, announcement bars, [llms.txt](https://nodejs.org/llms.txt) etc. | |
| We also care about the needs of every user, and we pay attention to the ones that are easy to overlook. Every page stays usable even with JavaScript disabled and offline. | |
| Like the current documentation, every page is generated from the same Markdown files in the [nodejs/node](https://github.com/nodejs/node) repository that power the current docs. However, navigation, layout, and readability were all reworked so that finding and understanding an API takes less effort. On top of that, the beta adds things the current docs have never had, including offline-compatible search, an `llms.txt` file, and a modern overhaul of the visual identity to match the rest of the Node.js brand. |
|
|
||
| We also care about the needs of every user, and we pay attention to the ones that are easy to overlook. Every page stays usable even with JavaScript disabled and offline. | ||
|
|
||
| ## Same content, new tooling |
There was a problem hiding this comment.
| ## Same content, new tooling | |
| ## Under-the-hood |
| Under the hood, the beta is built with [doc-kit](https://github.com/nodejs/doc-kit), a standalone tool built to replace the current documentation generator, which has lived inside Node.js core for years. | ||
|
|
||
| It parses the existing Markdown files and can produce several outputs from them: the redesigned web pages you see on the beta, plus the legacy HTML, JSON, man-page formats etc. Existing consumers of those formats keep working during the transition, and contributors keep editing the same Markdown files they always have. | ||
|
|
||
| There's a broader goal here too: any project can pick up doc-kit for its own documentation, inside or outside the Node.js ecosystem. And that's already happening. The [undici docs](https://undici.nodejs.org/) are built with doc-kit today, and [webpack is migrating](https://github.com/webpack/webpack-doc-kit) its API documentation as well. | ||
|
|
||
| If you're curious about the design and progress of the effort, the tracking issue at [nodejs/node#52343](https://github.com/nodejs/node/issues/52343) has the full picture. |
There was a problem hiding this comment.
| Under the hood, the beta is built with [doc-kit](https://github.com/nodejs/doc-kit), a standalone tool built to replace the current documentation generator, which has lived inside Node.js core for years. | |
| It parses the existing Markdown files and can produce several outputs from them: the redesigned web pages you see on the beta, plus the legacy HTML, JSON, man-page formats etc. Existing consumers of those formats keep working during the transition, and contributors keep editing the same Markdown files they always have. | |
| There's a broader goal here too: any project can pick up doc-kit for its own documentation, inside or outside the Node.js ecosystem. And that's already happening. The [undici docs](https://undici.nodejs.org/) are built with doc-kit today, and [webpack is migrating](https://github.com/webpack/webpack-doc-kit) its API documentation as well. | |
| If you're curious about the design and progress of the effort, the tracking issue at [nodejs/node#52343](https://github.com/nodejs/node/issues/52343) has the full picture. | |
| The redesigned documentation is built with [doc-kit](https://github.com/nodejs/doc-kit), a standalone tool developed by the Node.js Project to replace the previous, legacy, documentation generator. | |
| For more information on doc-kit, and its capabilities for other projects, please refer to [its repository]. This will also be the place where any and all bug reports, feature requests, and other tasks should be tracked. |
| ## We need your feedback | ||
|
|
||
| This is a beta, and we're publishing it early because we want people using it and giving us feedback, so we can iterate before the new docs replace the current ones. If you spend time in the API docs, try spending it on [beta.docs.nodejs.org](https://beta.docs.nodejs.org/) for a while and let us know how it goes. | ||
|
|
||
| Please open an issue on the [nodejs/doc-kit](https://github.com/nodejs/doc-kit/issues) repository with anything you find, big or small. The current documentation remains in place in the meantime, so nothing changes for you today — but with your help, the new docs will be ready to take over soon. |
There was a problem hiding this comment.
| ## We need your feedback | |
| This is a beta, and we're publishing it early because we want people using it and giving us feedback, so we can iterate before the new docs replace the current ones. If you spend time in the API docs, try spending it on [beta.docs.nodejs.org](https://beta.docs.nodejs.org/) for a while and let us know how it goes. | |
| Please open an issue on the [nodejs/doc-kit](https://github.com/nodejs/doc-kit/issues) repository with anything you find, big or small. The current documentation remains in place in the meantime, so nothing changes for you today — but with your help, the new docs will be ready to take over soon. | |
| ## We need your feedback | |
| While we are proud to state that the redesigned documentation is entering its final stage of development, feedback is still a crucial part of this migration, and we'd love to hear your thoughts on this process. |
|
I feel like some parts of this can be shortened, see my comments |
| --- | ||
| date: '2026-07-12T12:00:00.000Z' | ||
| category: announcements | ||
| title: Try the New Node.js API Documentation Beta |
There was a problem hiding this comment.
| title: Try the New Node.js API Documentation Beta | |
| title: Check out the Node.js API Documentation Redesign Preview |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Brian Muenzenmeyer <brian.muenzenmeyer@gmail.com>
17a246c to
f293f9e
Compare
Tbh I don't know if we need to be so direct in this blog post. It’s going to be the first interaction with the new doc for a lot of users, so we need to explain well and detail what we did and why we did it. |
f293f9e to
82e7259
Compare
Related to #8998