nodejs / abi-stable-node

Repository used by the Node-API team to manage work related to Node-API and node-addon-api
239 stars 47 forks source link

Consider adding to core documentation node-gyp, cmake, prebuild etc. #384

Closed mhdawson closed 4 years ago

mhdawson commented 4 years ago

There have been some question about cmake, we've done work around prebuild Should there be a section in the core documentation?

mhdawson commented 4 years ago

Jim will take a first cut.

mhdawson commented 4 years ago

Possible location: https://nodejs.org/dist/latest-v12.x/docs/api/addons.html#addons_building

mhdawson commented 4 years ago

Some additional info in https://github.com/nodejs/abi-stable-node/issues/386

jschlight commented 4 years ago

It appears that the Building section on the proposed page is part of a "Hello world" tutorial.

https://nodejs.org/dist/latest-v12.x/docs/api/addons.html#addons_building

My plan is to create documentation at a fairly high-level, pretty much describing the available tools and when you'd want to use them. But then linking off to the various tools for the specifics.

mhdawson commented 4 years ago

I'm not sure on the policy for linking out to other sites. I think adding to https://nodejs.org/api/n-api.html to start does make sense.