Skip to content

Add blurb to N-API documentation indicating that we recommend the use of badges #22796

Closed

Description

@gabrielschulhof

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    node-apiIssues and PRs related to Node-API.
    on Sep 10, 2018
  2. Tolsee commented on Sep 10, 2018

    @Tolsee

    @gabrielschulhof Willing to contribute to Node.js and I am watching over issues I can start my journey. Add documentation will be a good start I hope. Let me know If this is something I can work on.

  3. gabrielschulhof commented on Sep 10, 2018

    @gabrielschulhof
    ContributorAuthor

    @Tolsee absolutely! Our plan is to promote the use of the following badges:

    https://img.shields.io/badge/N--API-v1-green.svg
    https://img.shields.io/badge/N--API-v2-green.svg
    https://img.shields.io/badge/N--API-v3-green.svg
    https://img.shields.io/badge/N--API-experimental-orange.svg

    The addon maintainer should indicate the minimum version of N-API needed for their module. This translates to a range of supported Node.js major versions.

  4. gabrielschulhof commented on Sep 10, 2018

    @gabrielschulhof
    ContributorAuthor

    @Tolsee the file you'll want to modify is doc/api/n-api.md.

  5. sagitsofan commented on Sep 10, 2018

    @sagitsofan
    Contributor

    Hey @gabrielschulhof, i am willing to help also if it necessary

  6. ddlan commented on Sep 11, 2018

    @ddlan

    Hi @gabrielschulhof, I tried my hand at adding a blurb regarding the use of badges of N-API.

  7. Tolsee commented on Sep 11, 2018

    @Tolsee

    Looks like I missed it 😆

  8. siddhant1 commented on Sep 27, 2018

    @siddhant1
    Contributor

    Any work remaining on this one?

  9. tiagorvmartins commented on Nov 23, 2018

    @tiagorvmartins

    I am looking for a first issue at github, found this one, the status is open but seems like there was some references to an existing merge already, so can this be closed or can I help if needed? thanks!

  10. mhdawson commented on Nov 23, 2018

    @mhdawson
    Member

    I think @gabrielschulhof was helping to shepherd this so I'll let him answer/close but I think the required text was added to the abi-stable-node repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.node-apiIssues and PRs related to Node-API.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions