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 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 Reviewed by Cursor Bugbot for commit 989d073. 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.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. |
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 !!! |
|
I feel like some parts of this can be shortened, see my comments |
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
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Brian Muenzenmeyer <brian.muenzenmeyer@gmail.com>
0814242 to
feda0d5
Compare
| - **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. |
There was a problem hiding this comment.
The llms.txt is already stable, and not in preview
There was a problem hiding this comment.
But we didn't announce it yet, that's why I put it here
bmuenzenmeyer
left a comment
There was a problem hiding this comment.
explicit block until #8998 lands (IMO)
Related to #8998