You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi everyone,
I think that we have to take a decision about the gh-pages branch of this repo. Now it contains the old documentation created by Doxygen, but this documentation is not updated form the begin of July.
About that I have 3 proposals:
Drop the old documentation and disable the gh-pages
Continue to update the documentation generated by Doxygen
Use gh-pages to better advertise node-addon-api and in general N-API. We could use tools like Gatsby and create a simple web site exposed by the gh-pages. In the web site I would like to serve the new markdonwn documentation and other useful resources like materials of workshop and talks that we did.
I think that we can talk about this at Node.js Collaborator Summit.
At Node.js Collaborator Summit we discussed about the idea to expose the documentation through the GitHub pages like a web site.
For the occasion I created a mock-up to better explain the idea. I attached the screenshot in this issue remembering that it’s a prototype and we need working on it to arrive at final version.
I proposed to expose our markdown documentation through the web site together with some other resources that now we have to advertise if we want to increase the adoption of node-addon-api and N-API.
Now we have al the materials produced to create the N-API workshop and slides and videos of talks that members of the team did in this year.
In the discussion it turns out that other than the markdown documentation we need to provide a reference of the API like V8, so we will have the documentation and a reference of the API that will cover all the developers’ needs.
From my perspective this will be a long term project now I will start on create what I proposed on my own then I will present to you the result and after some iterations we will must to start thinking on how we want organize everything.
Please if someone have some other ideas I will be happy to discuss on this issue or in the next N-API team meeting.
Hi everyone,
I want start working on this and pass from design to a real prototype, but for me it could be great if you post useful resources that you want add to the "web site" so I can organise all for the best.
In the specific I need links yo articles, video (talks), slides and any useful resource that we can use to improve our evangelism activity.
We have not had progress on a new site and the Doxygen is long out of date so I went ahead and deleted the gh-pages branch which disables the publishing of the stale Doxygen, closing.
Activity
NickNaso commentedon Oct 9, 2018
Hi everyone,
I think that we have to take a decision about the gh-pages branch of this repo. Now it contains the old documentation created by Doxygen, but this documentation is not updated form the begin of July.
About that I have 3 proposals:
I think that we can talk about this at Node.js Collaborator Summit.
NickNaso commentedon Oct 16, 2018
At Node.js Collaborator Summit we discussed about the idea to expose the documentation through the GitHub pages like a web site.
For the occasion I created a mock-up to better explain the idea. I attached the screenshot in this issue remembering that it’s a prototype and we need working on it to arrive at final version.
I proposed to expose our markdown documentation through the web site together with some other resources that now we have to advertise if we want to increase the adoption of node-addon-api and N-API.
Now we have al the materials produced to create the N-API workshop and slides and videos of talks that members of the team did in this year.
In the discussion it turns out that other than the markdown documentation we need to provide a reference of the API like V8, so we will have the documentation and a reference of the API that will cover all the developers’ needs.
From my perspective this will be a long term project now I will start on create what I proposed on my own then I will present to you the result and after some iterations we will must to start thinking on how we want organize everything.
Please if someone have some other ideas I will be happy to discuss on this issue or in the next N-API team meeting.
NickNaso commentedon Nov 8, 2018
Hi everyone,
I want start working on this and pass from design to a real prototype, but for me it could be great if you post useful resources that you want add to the "web site" so I can organise all for the best.
In the specific I need links yo articles, video (talks), slides and any useful resource that we can use to improve our evangelism activity.
mhdawson commentedon Nov 15, 2018
From Node+JS Interactive: https://www.youtube.com/watch?v=BrJcsYjp8Nw
mhdawson commentedon Nov 15, 2018
From Node Summit: https://github.com/mhdawson/presentations/blob/master/2018/NodeSummit2018%20-%20Building%20Next%20Generation%20add-on%20modules%20for%20Node.js%20using%20N-API.pdf
romandev commentedon Nov 16, 2018
I'm not sure if this slide is helpful to you but anyway I'll share it.
https://docs.google.com/presentation/d/10RCRnKXHUJBl-Pe_LfB-5Uhd0ADhcvSR5978-7ckzWQ/edit?usp=sharing
mhdawson commentedon Nov 19, 2018
@romandev thanks for that link, looks like a good deck. We should get you to give us an update on how the webidl generator is going at some point.
NickNaso commentedon Jan 2, 2019
What do you think if we add something about the N-API badges in the web site for the documentation?
See: #334
Just a remainder for me see at this PR nodejs/abi-stable-node#357
mhdawson commentedon Jan 3, 2019
Makes sense toi me.
mhdawson commentedon Dec 7, 2020
We have not had progress on a new site and the Doxygen is long out of date so I went ahead and deleted the gh-pages branch which disables the publishing of the stale Doxygen, closing.
doc: remove unused Doxygen file
doc: remove unused Doxygen file (#851)
doc: remove unused Doxygen file (#851)
doc: remove unused Doxygen file (#851)
doc: remove unused Doxygen file (#851)
doc: remove unused Doxygen file (#851)