better documentation?

View: New views
4 Messages — Rating Filter:   Alert me  

better documentation?

by rogerdpack :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

I'm interested in helping the documentation for rspec, ex:

http://rspec.info/

described similarly to how this person feels (that there's not too
much "getting started" docu).

http://creativedeletion.com/2007/05/27/the-new-rspec-format-testingspecing-in-ruby/

Is there anywhere to fork or what not for the website?
Thanks.
-r
_______________________________________________
rspec-users mailing list
rspec-users@...
http://rubyforge.org/mailman/listinfo/rspec-users

Re: better documentation?

by David Chelimsky-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Nov 4, 2009, at 4:51 PM, rogerdpack wrote:

> I'm interested in helping the documentation for rspec, ex:
>
> http://rspec.info/
>
> described similarly to how this person feels (that there's not too
> much "getting started" docu).
>
> http://creativedeletion.com/2007/05/27/the-new-rspec-format-testingspecing-in-ruby/
>
> Is there anywhere to fork or what not for the website?

Hey Roger,

I really like what Aslak and the Cucumber community have done by  
making cukes.info more high level and building up more extensive  
documentation on the github wiki, so I'd rather put energy into  
beefing up the github wiki than improve rspec.info. What do you think?

Cheers,
David

> Thanks.
> -r

_______________________________________________
rspec-users mailing list
rspec-users@...
http://rubyforge.org/mailman/listinfo/rspec-users

Re: better documentation?

by rogerdpack :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


> I really like what Aslak and the Cucumber community have done by  
> making cukes.info more high level and building up more extensive  
> documentation on the github wiki, so I'd rather put energy into  
> beefing up the github wiki than improve rspec.info. What do you think?

Using a wiki sounds like a great idea.
-r
_______________________________________________
rspec-users mailing list
rspec-users@...
http://rubyforge.org/mailman/listinfo/rspec-users

Re: better documentation?

by Stephen Eley :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Thu, Nov 12, 2009 at 7:14 PM, rogerdpack <rogerpack2005@...> wrote:
>
>> I really like what Aslak and the Cucumber community have done by
>> making cukes.info more high level and building up more extensive
>> documentation on the github wiki, so I'd rather put energy into
>> beefing up the github wiki than improve rspec.info. What do you think?
>
> Using a wiki sounds like a great idea.

Agreed, but the wiki implementation on Github is too simplistic and
lacks the organizing  and search features to make it usable.  I think
the Cucumber project is evidence of this.  There are wikis much better
suited for the purpose, like Dokuwiki or TikiWiki.


--
Have Fun,
   Steve Eley (sfeley@...)
   ESCAPE POD - The Science Fiction Podcast Magazine
   http://www.escapepod.org
_______________________________________________
rspec-users mailing list
rspec-users@...
http://rubyforge.org/mailman/listinfo/rspec-users