diff options
| author | Vijay Dev <vijaydev.cse@gmail.com> | 2012-12-08 23:10:38 +0530 |
|---|---|---|
| committer | Vijay Dev <vijaydev.cse@gmail.com> | 2012-12-08 23:10:38 +0530 |
| commit | 729798068a54dbbe553c71f0283cb6ad74c2e77c (patch) | |
| tree | 2e91bfcdab85f8cca84419f2b8c37df97e2eed97 /guides | |
| parent | 4085dd60108a95da22854ee4ecb683578a9a3e7d (diff) | |
| download | rails-729798068a54dbbe553c71f0283cb6ad74c2e77c.tar.gz rails-729798068a54dbbe553c71f0283cb6ad74c2e77c.tar.bz2 rails-729798068a54dbbe553c71f0283cb6ad74c2e77c.zip | |
copy edits [ci skip]
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 3 | ||||
| -rw-r--r-- | 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. -------------------------------------------------------------------------------- |