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

chore: automate download node docs #696

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ccarruitero
Copy link
Contributor

I'm adding a script for download node api docs. The files seems slightly different from current files, because font is missing; but I think we don't have to worry about docs anymore with this.

current:
current
proposed:
proposed

@martinheidegger
Copy link
Contributor

This is a nice pull request and definitely something worth looking at. But honestly: I would rather have a "npm install node-docs@version" dependency that has the docs in the npm module with a path.

@ccarruitero
Copy link
Contributor Author

@martinheidegger I found that in the npm's information for that package (node-docs) is missing the repository also haven't any release.

My concern about use a dependency for docs is that the dependency could become unmaintained.

I think the script proposed isn't too big; and just scrape api docs from nodejs.org, rename result folder and cleanup other files.

@martinheidegger
Copy link
Contributor

martinheidegger commented Jun 10, 2020

I missed to reply here: The reason i bring it up is that this documentation may be used by other workshoppers (i.e. going-native). We could just create a @workshopper/node-docs package.

What do you think?

@ccarruitero
Copy link
Contributor Author

That's sounds good.

But I prefer that the docs package just scrape node docs. That way is more easy to maintain the package.

We could scrape latest version by default and use an env variable for a specific node version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants