search

rails-girls-summer-of-code / projects

24 stars 7 forks source link

Official Ruby Documentation Redesign #7

Closed zzak closed 8 years ago

zzak commented 9 years ago

Name and Contact of the Project Mentor: Zachary Scott, @zzak, zzak@ruby-lang.org, e@zzak.io

Name of the Project: Official Ruby Documentation Redesign

URL: http://docs.ruby-lang.org/

About the Project: Design an attractive and useful template for reading Ruby documentation, made available as the official ruby-lang.org language reference documentation.

Suitable for beginners? Requirements would include:

What are issues/features students may work on?

Students would be designing and implementing a new template for the English documentation for ruby-lang.org. Ideally we would start from the existing template, since it already has some nice features baked in, such as: searchable content, and enhanced accessibility for screen-readers. These are important features that would need to remain supported in the re-design.

pxlpnk commented 9 years ago

<3

svenfuchs commented 9 years ago

@zzak :heart:

fxn commented 9 years ago

:heart: :heart: :heart: :heart: :heart: :heart: :heart: :heart: :heart: :heart:

FloorD commented 9 years ago

:stars:

anikalindtner commented 9 years ago

awesome, @zzak. Thanks for submitting. Accepted \o/

zzak commented 9 years ago

Woooooo <3

On Friday, February 6, 2015, Anika notifications@github.com wrote:

awesome, @zzak https://github.com/zzak. Thanks for submitting. Accepted \o/

— Reply to this email directly or view it on GitHub https://github.com/rails-girls-summer-of-code/projects/issues/7#issuecomment-73284970 .

arianepaola commented 9 years ago

Hello @zzak

Our team, Ramya @Aumrr and Ariane @arianepaola would love to work on this project.

Thanks, Ariane

zzak commented 9 years ago

@arianepaola @Aummrr Great!

How do we proceed?

arianepaola commented 9 years ago

@zzak do you have any other requirements for the project than above?

We saw that Ruby is mirrored to github, but could not find the entry point for the rdoc files and templates. There is probably more to it, than just calling RDoc for all files :-)

Ruby on Rails also uses RDoc and their template is nice http://api.rubyonrails.org/

We also saw http://ruby-doc.org/ which is linked from the official Ruby website. How is it involved or are these two different documentations?

Thanks, Ariane

zzak commented 9 years ago

@arianepaola Let's chat about requirements over email, but to answer your questions:

The generator for docs.ruby-lang.org is here, this is mostly just some Rake tasks to use RDoc on ruby source for various branches and releases: https://github.com/ruby/docs.ruby-lang.org

The documentation template for api.rubyonrails.org uses sdoc: https://github.com/voloko/sdoc

Sdoc is really just an RDoc plugin, much like the other templates for Rdoc (darkfish), it can generate the HTML for us.

ruby-doc.org is not maintained by us, but rather a 3rd-party. It is nice, but I think we can make a really awesome website to be the official location for Ruby docs!