Skip to content

feat: create beta API docs announcement post#9002

Merged
bmuenzenmeyer merged 8 commits into
nodejs:mainfrom
araujogui:api-docs-beta-blogpost
Jul 24, 2026
Merged

feat: create beta API docs announcement post#9002
bmuenzenmeyer merged 8 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 24, 2026 7:26pm

Request Review

@cursor

cursor Bot commented Jul 13, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Static blog content and author metadata only; no application logic or infrastructure changes.

Overview
Adds an announcements blog post that introduces the beta.docs.nodejs.org API documentation preview, highlights reader-facing changes (search, shared nodejs.org design, llms.txt, accessibility), points to doc-kit and feedback via nodejs/doc-kit, and credits the Web Team.

Registers Guilherme Araújo in authors.json so the post’s author front matter resolves correctly.

Reviewed by Cursor Bugbot for commit 81f30d8. 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.48%. Comparing base (a19ca6c) to head (81f30d8).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9002   +/-   ##
=======================================
  Coverage   74.48%   74.48%           
=======================================
  Files         100      100           
  Lines        8818     8823    +5     
  Branches      325      325           
=======================================
+ Hits         6568     6572    +4     
- Misses       2246     2247    +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.65 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
Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated

@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)

araujogui and others added 6 commits July 24, 2026 16:13
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brian Muenzenmeyer <brian.muenzenmeyer@gmail.com>
Copilot AI review requested due to automatic review settings July 24, 2026 19:13
@araujogui
araujogui force-pushed the api-docs-beta-blogpost branch from 989d073 to 23de560 Compare July 24, 2026 19:13

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

apps/site/pages/en/blog/announcements/new-api-docs-beta.md:33

  • This sentence is a bit of a run-on with multiple comma-separated clauses; splitting it improves readability.
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. Please open an issue on the [nodejs/doc-kit](https://github.com/nodejs/doc-kit/issues) repository with anything you find, big or small.

Comment thread apps/site/pages/en/blog/announcements/new-api-docs-beta.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Guilherme Araújo <arauujogui@gmail.com>

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

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

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

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

Comments suppressed due to low confidence (1)

apps/site/pages/en/blog/announcements/new-api-docs-beta.md:19

  • The post links to https://nodejs.org/llms.txt and states it has already shipped, but this repo doesn’t appear to contain an llms.txt static asset or route (no matches under apps/site). That likely makes the link incorrect/broken in local builds and preview deploys, and could mislead readers if the file isn’t actually served from nodejs.org.
- **llms.txt**: We've already shipped [llms.txt](https://nodejs.org/llms.txt), giving AI tools a clean, structured entry point to the API reference.

@araujogui
araujogui enabled auto-merge July 24, 2026 19:30
@bmuenzenmeyer
bmuenzenmeyer disabled auto-merge July 24, 2026 19:35
@bmuenzenmeyer
bmuenzenmeyer merged commit 36f4983 into nodejs:main Jul 24, 2026
15 checks passed
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