Documentation update

Gavin Sinclair gsinclair at gmail.com
Thu Oct 13 18:16:58 EDT 2005


On 10/12/05, Gavin Sinclair <gsinclair at gmail.com> wrote:
>
> So can people suggest what should go in the "one consolidated
> document"?  Pretend I know nothing about the project and suggest
> _anything_.
>

No bites?  What a surprise...

Anyway, I thought just presenting the site as a FAQ would be good. 
Here are the questions I've come up with.  Any others to add?

What is the vim-ruby project?
  - basic description, components

How do you get it?
  - gem, tarball

How do you install it?
  - gem, tarball

What Vim config do I need?
  - definitive answer

How do I know that everything's working?
  - a few things to try

How do I use it?
  - summary of commands

I want feature X.  Will you include it?
  - probably not

What are some other cool Ruby-related Vim tricks I can use?
  - nice summary + links

How can I report a bug?
  - bug tracker or mailing list or file maintainer (in that order of preference)

I have another question...
  - mailing list or file maintainer



More information about the vim-ruby-devel mailing list