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

[Feature]: Proper Documentation #1138

Closed
Silentboy7707 opened this issue May 12, 2024 · 1 comment
Closed

[Feature]: Proper Documentation #1138

Silentboy7707 opened this issue May 12, 2024 · 1 comment

Comments

@Silentboy7707
Copy link

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

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.

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

No branches or pull requests

2 participants