Skip to content

feat: create beta API docs announcement post#9002

Open
araujogui wants to merge 6 commits into
nodejs:mainfrom
araujogui:api-docs-beta-blogpost
Open

feat: create beta API docs announcement post#9002
araujogui wants to merge 6 commits into
nodejs:mainfrom
araujogui:api-docs-beta-blogpost

Conversation

@araujogui

Copy link
Copy Markdown
Member

Related to #8998

Copilot AI review requested due to automatic review settings July 13, 2026 03:07
@araujogui
araujogui requested review from a team as code owners July 13, 2026 03:07
@vercel

vercel Bot commented Jul 13, 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 20, 2026 8:55pm

Request Review

@cursor

cursor Bot commented Jul 13, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and site content only; no runtime, auth, or application logic changes.

Overview
Adds a new announcements blog post that promotes the beta.docs.nodejs.org API documentation preview and asks readers to try it and file feedback on nodejs/doc-kit.

The post highlights reader-facing changes (built-in search, shared nodejs.org design, llms.txt, JS-disabled/offline usability) and notes that content still comes from the same nodejs/node Markdown sources, with generation moving to doc-kit.

Registers Guilherme Araújo in authors.json so the post can use that byline.

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

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.57%. Comparing base (7dac7d8) to head (989d073).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9002   +/-   ##
=======================================
  Coverage   74.57%   74.57%           
=======================================
  Files         100      100           
  Lines        8803     8808    +5     
  Branches      324      324           
=======================================
+ Hits         6565     6569    +4     
- Misses       2234     2235    +1     
  Partials        4        4           

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

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

Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

📦 Build Size Comparison

Summary

Metric Value
Old Total First Load JS 10.64 MB
New Total First Load JS 10.65 MB
Delta 3.80 KB (+0.03%)

Changes

🔄 Modified Routes (4)
Route Old First Load JS New First Load JS Delta
/[locale] 2.54 MB 2.54 MB 📈 972.00 B (+0.04%)
/[locale]/[...path] 2.54 MB 2.54 MB 📈 972.00 B (+0.04%)
/[locale]/blog/[...path] 2.54 MB 2.54 MB 📈 972.00 B (+0.04%)
/[locale]/download/archive/[version] 2.54 MB 2.54 MB 📈 972.00 B (+0.04%)

Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md
@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

great work @araujogui !!!

Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
@avivkeller

Copy link
Copy Markdown
Member

I feel like some parts of this can be shortened, see my comments

Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
@araujogui

araujogui commented Jul 13, 2026

Copy link
Copy Markdown
Member Author

I feel like some parts of this can be shortened, see my comments

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.

@bjohansebas bjohansebas 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.

LGTM!

Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
araujogui and others added 4 commits July 20, 2026 16:58
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brian Muenzenmeyer <brian.muenzenmeyer@gmail.com>
- **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.

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.

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.

The llms.txt is already stable, and not in preview

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

But we didn't announce it yet, that's why I put it here

@bmuenzenmeyer bmuenzenmeyer 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.

explicit block until #8998 lands (IMO)

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.

6 participants