Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add blurb to N-API recommending the use of badges #22801

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,17 @@ opt-in to access those APIs:
In this case the entire API surface, including any experimental APIs, will be
available to the module code.

### Badges
ddlan marked this conversation as resolved.
Show resolved Hide resolved

The use of badges is recommended to indicate the minimum version of N-API
required for the module. This helps to determine which Node.js major versions
are supported. The following badges are available:

![N-API v1 Badge](../api_assets/N-API%20v1%20Badge.svg)
![N-API v2 Badge](../api_assets/N-API%20v2%20Badge.svg)
![N-API v3 Badge](../api_assets/N-API%20v3%20Badge.svg)
![N-API Experimental Version Badge](../api_assets/N-API%20Experimental%20Version%20Badge.svg)
Copy link
Member

Choose a reason for hiding this comment

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

Have you verified that this works in the make doc output? I think most of our assets are included via assets/, not some ../-prefixed path


ddlan marked this conversation as resolved.
Show resolved Hide resolved
## N-API Version Matrix

| | 1 | 2 | 3 |
Expand Down
1 change: 1 addition & 0 deletions doc/api_assets/N-API Experimental Version Badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/api_assets/N-API v1 Badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/api_assets/N-API v2 Badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/api_assets/N-API v3 Badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.