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.

Sign up for GitHub

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

Jump to bottom

markdown docs #76

Closed
mcollina opened this issue Jul 10, 2017 · 4 comments
Closed

markdown docs #76

mcollina opened this issue Jul 10, 2017 · 4 comments

Comments

@mcollina
Copy link
Member

I think documentation in markdown is more user-friendly than the autogenerated one. Given that the API in this modules would likely be very stable, we should probably put the effort.
@NickNaso
Copy link
Member

Hi everyone,
I agree with @mcollina that have a markdown documentation is better than the autogenerated one. If you want in next month I'll available start writing the documentations. What do you think about? In case have you some specifications to follow?

@mhdawson
Copy link
Member

There is an effort stated do add documentation. You can follow it here: nodejs/abi-stable-node#280

@NickNaso
Copy link
Member

Hi @mcollina,
today finally we completed all the steps to create the markdown documentation. We close the issue nodejs/abi-stable-node#280.
Is it possible close this issue?

@mcollina
Copy link
Member Author

Definitely! Good work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mcollina @NickNaso @mhdawson