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

Remove outdated Doxygen doc #368

Closed
mhdawson opened this issue Oct 9, 2018 · 10 comments
Closed

Remove outdated Doxygen doc #368

mhdawson opened this issue Oct 9, 2018 · 10 comments
Labels

Comments

@mhdawson
Copy link
Member

mhdawson commented Oct 9, 2018

We have not kept it up to date and we have full coverage in our other doc, so remove it.

@NickNaso
Copy link
Member

NickNaso commented 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:

  • 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.

@NickNaso NickNaso added the doc label Oct 9, 2018
@NickNaso
Copy link
Member

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.
screenshot 2018-10-15 at 17 44 01
screenshot 2018-10-15 at 17 44 14
screenshot 2018-10-15 at 17 44 32

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
Copy link
Member

NickNaso commented 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
Copy link
Member Author

From Node+JS Interactive: https://www.youtube.com/watch?v=BrJcsYjp8Nw

@mhdawson
Copy link
Member Author

@romandev
Copy link
Contributor

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
Copy link
Member Author

@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
Copy link
Member

NickNaso commented 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
Copy link
Member Author

mhdawson commented Jan 3, 2019

Makes sense toi me.

@mhdawson
Copy link
Member Author

mhdawson commented 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.

@mhdawson mhdawson closed this as completed Dec 7, 2020
mhdawson added a commit to mhdawson/node-addon-api that referenced this issue Dec 7, 2020
Refs: nodejs#368

Signed-off-by: Michael Dawson <[email protected]>
mhdawson added a commit that referenced this issue Dec 10, 2020
Refs: #368

Signed-off-by: Michael Dawson <[email protected]>
kevindavies8 added a commit to kevindavies8/node-addon-api-Develop that referenced this issue Aug 24, 2022
Marlyfleitas added a commit to Marlyfleitas/node-api-addon-Development that referenced this issue Aug 26, 2022
wroy7860 added a commit to wroy7860/addon-api-benchmark-node that referenced this issue Sep 19, 2022
johnfrench3 pushed a commit to johnfrench3/node-addon-api-git that referenced this issue Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants