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

Add documentation for vim #144

Closed
ultimatecoder opened this Issue Mar 6, 2017 · 3 comments

Comments

Projects
None yet
3 participants
@ultimatecoder

ultimatecoder commented Mar 6, 2017

  • Description: Recently I was trying to look this plugin. I found it does have guidelines at README.md file but it is missing the documentation for vim editor. I believe it is required to provide one copy of documentation so that the user don't have to come here for it. Providing vim help can be a more handy option than providing help here.

  • What I can do?
    I have never written any help for any vim plugin before. But I want to get some experience on it. If someone is able to provide proper guidance I am happy to do this job.

@junegunn

This comment has been minimized.

Show comment
Hide comment
@junegunn

junegunn Mar 8, 2017

Owner

I appreciate your proposal, but I have a private script for converting markdown document to vim help file, so that's not necessary.

While I agree that providing vim help is beneficial for the users, I personally don't like having to maintain the document in two different formats and keep them in sync. I'll think about it.

Having said that, since nowadays we install plugins by cloning the whole repository using a plugin mananger, README.md file should be available on the user's disk drive. If you use vim-plug and fzf.vim, you can browse the plugins files and find README.md file under a certain plugin directory.

:execute 'Files' g:plug_home
Owner

junegunn commented Mar 8, 2017

I appreciate your proposal, but I have a private script for converting markdown document to vim help file, so that's not necessary.

While I agree that providing vim help is beneficial for the users, I personally don't like having to maintain the document in two different formats and keep them in sync. I'll think about it.

Having said that, since nowadays we install plugins by cloning the whole repository using a plugin mananger, README.md file should be available on the user's disk drive. If you use vim-plug and fzf.vim, you can browse the plugins files and find README.md file under a certain plugin directory.

:execute 'Files' g:plug_home

@junegunn junegunn closed this Mar 8, 2017

@chreekat

This comment has been minimized.

Show comment
Hide comment
@chreekat

chreekat Mar 30, 2017

While I agree that providing vim help is beneficial for the users, I personally don't like having to maintain the document in two different formats and keep them in sync. I'll think about it.

Please do. :) One of the most valuable implicit contracts that plugin writers uphold in Vim is the inclusion of help files. I understand that you don't want to maintain two sets of documents (vim and README), but I believe if you have to choose, choose help.

chreekat commented Mar 30, 2017

While I agree that providing vim help is beneficial for the users, I personally don't like having to maintain the document in two different formats and keep them in sync. I'll think about it.

Please do. :) One of the most valuable implicit contracts that plugin writers uphold in Vim is the inclusion of help files. I understand that you don't want to maintain two sets of documents (vim and README), but I believe if you have to choose, choose help.

@chreekat

This comment has been minimized.

Show comment
Hide comment
@chreekat

chreekat commented Mar 30, 2017

junegunn added a commit that referenced this issue Apr 1, 2017

@junegunn junegunn referenced this issue Apr 1, 2017

Closed

Add help doc #145

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