search

coreybutler / nvm-windows

A node.js version management utility for Windows. Ironically written in Go.
MIT License
37.28k stars 3.32k forks source link

[Feature]: Proper Documentation #1138

Closed Silentboy7707 closed 4 months ago

Silentboy7707 commented 4 months ago

Description of the new feature / enhancement

The code is not properly documented, Its messed up actually So I will help you out with a better documentation for easy Installation for those who just want to Install and use and below that for the developers and issue guide type.

Scenario when this would be used?

This would be helpful in every case making it more popular and all in one solution in our repository.

Supporting information

No response

coreybutler commented 4 months ago

It's pretty hard to not document Go code, given that it is auto-generated. https://pkg.go.dev/github.com/coreybutler/nvm-windows/src. The installation process is "click and follow the wizard".

Anyhow, you're welcome to document whatever you want (I recommend a blog article)... I certainly don't want to discourage that. However; new documentation is not a high priority for the project, and with 10M+ downloads, it seems like most people have figured out how to use it. Before you spend your time on this, remember, NVM4W will be deprecated when we release Runtime.