Skip to content
This repository has been archived by the owner on Nov 7, 2022. It is now read-only.

Make vim help docs #317

Open
ckipp01 opened this issue Oct 15, 2020 · 2 comments
Open

Make vim help docs #317

ckipp01 opened this issue Oct 15, 2020 · 2 comments
Labels
task General task that needs to be completed

Comments

@ckipp01
Copy link
Member

ckipp01 commented Oct 15, 2020

Task

There is a lot of docs just stuffed in the readme. Much of it is duplicated in the Metals website. I'd like to focus on the screen shots and examples on the website, and for the extension move all the documentation to vim help docs.

@ckipp01 ckipp01 added the task General task that needs to be completed label Oct 15, 2020
@jsatk
Copy link
Collaborator

jsatk commented Aug 4, 2021

I'd be happy to take a pass at this @ckipp01. Let me know. 😄

@ckipp01
Copy link
Member Author

ckipp01 commented Aug 5, 2021

So I'm actually not fully sure the best way to do this as it's not installed like a normal Vim plugin, so by default the docs won't be picked up. So it'd take a little bit of research to figure out how to get the docs available from :h. Altogether I'm a bit annoyed with having docs here and on the website, so I'm all open to suggestions about the cleanest way to just have everything in one place if possible and pointing to it from the other places. That's what I do with nvim-metals and it works pretty alright. Although I do get some people saying the docs are lacking because they only look on the website or the readme instead of in the help docs. What do you think?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
task General task that needs to be completed
Projects
None yet
Development

No branches or pull requests

2 participants