Start documentation

[NickNaso]

Start work on documentation

[mhdawson]

LGTM

[mhdawson]

Landed as 5543c01

[addaleax]

Uh … this was merged fast.

@NickNaso How is this documentation going to differ from https://nodejs.github.io/node-addon-api/ ?

[NickNaso]

Hi @addaleax,
we are writing the documentation through markdown. We started to organize the readme and to split the documentation in different sections. It's only the start. At the end of writing we will use the markdown file to generate a documentation web site to publish on https://nodejs.github.io/node-addon-api/.
I really want go aver the normal documentation reference and explain in a more expressive way how to use some API provided by the node-addon-api
I hope that you share the idea and if you want propose yours it will be great

[addaleax]

I really want go aver the normal documentation reference and explain in a more expressive way how to use some API provided by the node-addon-api

I am very much a fan of that! What I’m asking is why we’re not integrating that with the existing API documentation, which is rather complete and pretty useful imo?

[NickNaso]

At the end we need combining both maybe like proposed here:
nodejs/abi-stable-node#280 (comment)
Personally I'm thinking on how to do that even if I haven't a clear idea on how to do that.

[mhdawson]

@addaleax the main reason in my mind that we might not integrate with the existing API doc (and why I've not thought of doing that) is that node-addon-api is not "officially" part of Node.js. It's a helper module that happens to be provided by the Node.js community.

Having said that, I'm not opposed to integrating if we think that's the right thing to do.

In terms of this PR landing fast, it was opened to replace #182 which had been open for quite a while. We could just not get it into a form that we could land. Of course we missed adding that context to this PR which would have been good.

[addaleax]

@mhdawson Just to make sure we’re talking about the same thing: When I said “existing” documentation, I was referring to the linked https://nodejs.github.io/node-addon-api/ (i.e. documentation for this very module), not the docs for the C interface that are part of Node.