# How to help in reviewing the "guides"

**URL:** <https://www.ruby-forum.com/t/how-to-help-in-reviewing-the-guides/161902>\
**Category:** Rails\
**Created:** [March 3, 2009, 4:47pm UTC](https://www.ruby-forum.com/t/how-to-help-in-reviewing-the-guides/161902 "2009-03-03T16:47:48Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![wpvanpaassen](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/6f9a4e/32.png) [@wpvanpaassen](https://www.ruby-forum.com/u/wpvanpaassen)\
**Post date:** [March 3, 2009, 4:47pm UTC](https://www.ruby-forum.com/t/how-to-help-in-reviewing-the-guides/161902/1 "2009-03-03T16:47:48Z")

</div>

Hi,

Thanks to the previous post, I just discovered the pages with the guides

[http://guides.rubyonrails.org/](http://guides.rubyonrails.org/)

Knowing myself, once I start reading, I will end up with a bunch of  
small  
comments all over the place (I tend to be fairly pedantic …). I will  
probably  
discuss language issues, parts where the explanation could be more clear  
(for a newcomer) and probably test the examples.

What is the efficient way to contribute these comments (which I  
expect to be a large amount of small edits) ? I would have no problem  
editing the source document and providing a diff if that is useful.

Please advise me how I could be most efficient here.

Thanks,

Peter

---

<div class="post-metadata">

**Author:** ![wpvanpaassen](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/6f9a4e/32.png) [@wpvanpaassen](https://www.ruby-forum.com/u/wpvanpaassen)\
**Post date:** [March 3, 2009, 5:49pm UTC](https://www.ruby-forum.com/t/how-to-help-in-reviewing-the-guides/161902/2 "2009-03-03T17:49:44Z")

</div>

On 3 Mar 2009, at 15:47, Peter V. wrote:

> comments all over the place (I tend to be fairly pedantic …). I  
> will probably  
> discuss language issues, parts where the explanation could be more  
> clear  
> (for a newcomer) and probably test the examples.
> 
> What is the efficient way to contribute these comments (which I  
> expect to be a large amount of small edits) ? I would have no problem  
> editing the source document and providing a diff if that is useful.

If you pop into the #docrails channel I’m sure you can get commit  
access to docrails (which is where the doc stuff happens) or get them  
to apply your patches. For guides still in progress there are also  
lighthouse tickets.

Fred

---

<div class="post-metadata">

**Author:** ![wpvanpaassen](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/6f9a4e/32.png) [@wpvanpaassen](https://www.ruby-forum.com/u/wpvanpaassen)\
**Post date:** [March 3, 2009, 5:58pm UTC](https://www.ruby-forum.com/t/how-to-help-in-reviewing-the-guides/161902/3 "2009-03-03T17:58:34Z")

</div>

On Tue, Mar 3, 2009 at 5:48 PM, Frederick C.  
[removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> If you pop into the #docrails channel I’m sure you can get commit  
> access to docrails (which is where the doc stuff happens) or get them  
> to apply your patches. For guides still in progress there are also  
> lighthouse tickets.

Using your #docrails hint as input to Google, I found this page that  
seems to be  
a good and recent entry point for this matter. I will surely find my  
way from there.

[Ruby on Rails — Rails Documentation Projects](http://weblog.rubyonrails.org/2009/1/15/rails-documentation-projects)

Thanks again,

Peter