Skip to content

documenting-ruby/documenting-ruby.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ruby Documentation Project

This site contains tips, tricks and other useful information on how to contribute to MRI documentation.

It will have:

  • Detailed, step by step contribution guide
  • Lists of areas in MRI that are poorly documented or undocumented and should be given high priority
  • Current coverage reports

In addition it will sport:

  • Links to different resources (tutorials, screencasts, tools) around the topic of submitting documentation patches
  • Miscellaneous tips and tricks, such as rebasing a number of commits into one
  • Walkthroughs with example documentation patches

...