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 81f30d8. 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.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. |
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
0814242 to
feda0d5
Compare
bmuenzenmeyer
left a comment
There was a problem hiding this comment.
explicit block until #8998 lands (IMO)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Brian Muenzenmeyer <brian.muenzenmeyer@gmail.com>
989d073 to
23de560
Compare
There was a problem hiding this comment.
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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Guilherme Araújo <arauujogui@gmail.com>
There was a problem hiding this comment.
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.
Related to #8998