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

chezmoi.vim should have a proper vim help file #36

Open
j-xella opened this issue Jan 25, 2022 · 1 comment
Open

chezmoi.vim should have a proper vim help file #36

j-xella opened this issue Jan 25, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@j-xella
Copy link
Contributor

j-xella commented Jan 25, 2022

It seems to me that it is now becoming increasingly uncomfortable to maintain all the plugin's techical details in a section of README.md file.

I would suggest creating something like doc/chezmoi.vim.txt and using it as a golden source of detailed technical documentation. README.md should:

  • redirect user to doc/chezmoi.vim.txt for more details
  • mention that the help file should be indexed with :helptags during the plugin installation
@alker0
Copy link
Owner

alker0 commented Jan 26, 2022

Thank you for suggestions. I have never implemented vimdoc and don't know what is going to do (are any tools supposed to use, if so, what). For little time and experience, I can not get right on.
Help appreciated.

@alker0 alker0 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@j-xella @alker0