From 729798068a54dbbe553c71f0283cb6ad74c2e77c Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Sat, 8 Dec 2012 23:10:38 +0530 Subject: copy edits [ci skip] --- guides/source/api_documentation_guidelines.md | 3 +-- guides/source/ruby_on_rails_guides_guidelines.md | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 5c4aae8900..d0499878da 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -5,9 +5,8 @@ This guide documents the Ruby on Rails API documentation guidelines. After reading this guide, you will know: -* What RDoc is. * How to write effective prose for documentation purposes. -* Style guidlines for documenting different kinds of Ruby code. +* Style guidelines for documenting different kinds of Ruby code. -------------------------------------------------------------------------------- diff --git a/guides/source/ruby_on_rails_guides_guidelines.md b/guides/source/ruby_on_rails_guides_guidelines.md index 5031a1b531..a78711f4b2 100644 --- a/guides/source/ruby_on_rails_guides_guidelines.md +++ b/guides/source/ruby_on_rails_guides_guidelines.md @@ -5,8 +5,8 @@ This guide documents guidelines for writing Ruby on Rails Guides. This guide fol After reading this guide, you will know: -* Standards for writing and formatting rails guide source files -* How to generate HTML documentation from source files +* About the conventions to be used in Rails documentation. +* How to generate guides locally. -------------------------------------------------------------------------------- -- cgit v1.2.3