$ the-wire · showcase
Rails docs move from RDoc to Markdown across Action Pack and Action Mailer
By RepoJournal · Filed · About Rails · Composed from the cited sources · methodology
1 person shipped this
Xavier Noria is converting Rails' framework documentation from RDoc markup to Markdown, starting with Action Pack and Action Mailer, and correcting a private-marker bug along the way.
RDoc to Markdown in Action Pack rails/rails
Action Pack's documentation is now written in Markdown rather than RDoc markup, which changes how the framework's own source renders when built into API docs. Worth a look before your next docs build if you generate guides or API docs from a Rails checkout.
RDoc to Markdown in Action Mailer rails/rails
Action Mailer is the second component moved off RDoc markup and onto Markdown formatting in the same effort. Components converted so far are the two named commits; expect the remaining Rails frameworks to follow gradually.
Fix RDoc private marker rails/rails
A small fix corrects the private marker used in RDoc output, so members marked private are flagged correctly rather than left mislabeled in generated documentation. No runtime behavior changes.
