Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds a new Node-API (N-API) documentation section to the Learn site, including sidebar navigation and a set of rewritten guides ported from node-addon-examples.
Changes:
- Add a new “Node-API” group to
site.jsonsidebar navigation. - Add new Node-API docs pages (overview, getting started, build tools, special topics).
- Update Sidebar pathname handling to better support
index.md-based routes.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 32 comments.
Show a summary per file
| File | Description |
|---|---|
| site.json | Adds “Node-API” section + links to the Learn sidebar |
| components/Sidebar/index.jsx | Adjusts pathname handling to strip /index |
| pages/napi/index.md | Introduces Node-API landing page content |
| pages/napi/getting-started/index.md | Adds Getting Started index page |
| pages/napi/getting-started/prerequisites.md | Adds prerequisites content |
| pages/napi/getting-started/tools.md | Adds tooling/setup guidance |
| pages/napi/getting-started/project-structure.md | Adds shared project structure reference |
| pages/napi/getting-started/your-first-project.md | Adds first-project tutorial |
| pages/napi/getting-started/objectwrap.md | Adds ObjectWrap tutorial |
| pages/napi/getting-started/migration.md | Adds NAN → Node-API migration tutorial |
| pages/napi/build-tools/index.md | Adds build-tools index page |
| pages/napi/build-tools/node-gyp.md | Adds node-gyp guide |
| pages/napi/build-tools/cmake-js.md | Adds CMake.js guide |
| pages/napi/build-tools/node-pre-gyp.md | Adds node-pre-gyp guide |
| pages/napi/build-tools/prebuild.md | Adds prebuild guide |
| pages/napi/special-topics/index.md | Adds special-topics index page |
| pages/napi/special-topics/asyncworker.md | Adds AsyncWorker guide |
| pages/napi/special-topics/object-function-refs.md | Adds references guide |
| pages/napi/special-topics/thread-safe-functions.md | Adds thread-safe functions guide |
| pages/napi/special-topics/context-awareness.md | Adds context-awareness guide + examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Aviv Keller <me@aviv.sh> Signed-off-by: Aviv Keller <me@aviv.sh>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cc @nodejs/node-api
I've re-written these files from https://github.com/nodejs/node-addon-examples/tree/main/website/docs. Please note that these files are not identical to the previous versions. I've made some minor adjustments, including, but not limited to:
pages/napi/getting-started/project-structure.md, and addingindex.mdpagesThe authors of these files are currently marked as @gabrielschulhof, @NickNaso, @jschlight, @mhdawson, @KevinEady, and myself, @avivkeller.