Added docs for index as blog and updated the docs/ folder

Author: gregbell

docs/3-index-pages/index-as-block.md

@@ -1,12 +1,16 @@
 <!-- Please don't edit this file. It will be clobbered. -->
 
-Simplest rendering possible. Calls the block for each element in the collection.
+# Index as a Block
 
-Example:
+If you want to fully customize the display of your resources on the index
+screen, Index as a Block allows you to render a block of content for each
+resource.
 
-  ActiveAdmin.register Post do
-    index :as => :block do |post|
-      # render the post partial (app/views/admin/posts/_post)
-      render 'post', :post => post 
-    end
-  end
+    index :as => :block do |product|
+      div :for => product do
+        h2 auto_link(product.title)
+        div do
+          simple_format product.description
+        end
+      end
+    end

docs/3-index-pages/index-as-blog.md

@@ -1,2 +1,61 @@
 <!-- Please don't edit this file. It will be clobbered. -->
 
+# Index as Blog
+
+Render your index page as a set of posts. The post has two main options:
+title and body.
+
+  index :as => :blog do
+    title :my_title # Calls #my_title on each resource
+    body  :my_body  # Calls #my_body on each resource
+  end
+
+## Post Title
+
+The title is the content that will be rendered within a link to the
+resource. There are two main ways to set the content for the title
+
+First, you can pass in a method to be called on your
+resource. For example:
+
+  index :as => :blog do
+    title :a_method_to_call
+  end
+
+This will result in the title of the post being the return value of
+#a_method_to_call
+
+Second, you can pass a block to the tile option which will then be
+used as the contents fo the title. The resource being rendered
+is passed in to the block. For Example:
+
+  index :as => :blog do
+    title do |post|
+      span post.title, :class => 'title'
+      span post.created_at, :class => 'created_at'
+    end
+  end
+
+## Post Body
+
+The body is rendered underneath the title of each post. The same two
+style of options work as the Post Title above.
+
+Call a method on the resource as the body:
+
+  index :as => :blog do
+    title :my_title
+    body :my_body # Return value of #my_body will be the body
+  end
+
+Or, render a block as the body:
+
+  index :as => :blog do
+    title :my_title
+    body do |post|
+      div truncate(post.title)
+      div :class => 'meta' do
+        span "Post in #{post.categories.join(', ')}"
+      end
+    end
+  end

docs/3-index-pages/index-as-grid.md

@@ -1,2 +1,21 @@
 <!-- Please don't edit this file. It will be clobbered. -->
 
+# Index as a Grid
+
+Sometimes you want to display the index screen for a set of resources as a grid
+(possibly a grid of thumbnail images). To do so, use the :grid option for the
+index block.
+
+    index :as => :grid do |product|
+      link_to(image_tag(product.image_path), admin_products_path(product))
+    end
+
+The block is rendered within a cell in the grid once for each resource in the
+collection. The resource is passed into the block for you to use in the view.
+
+You can customize the number of colums that are rendered using the columns
+option:
+
+    index :as => :grid, :columns => 5 do |product|
+      link_to(image_tag(product.image_path), admin_products_path(product))
+    end

lib/active_admin/views/index_as_blog.rb

@@ -1,5 +1,66 @@
 module ActiveAdmin
   module Views
+
+    # = Index as Blog
+    #
+    # Render your index page as a set of posts. The post has two main options:
+    # title and body.
+    #
+    #   index :as => :blog do
+    #     title :my_title # Calls #my_title on each resource
+    #     body  :my_body  # Calls #my_body on each resource
+    #   end
+    #
+    # == Post Title
+    #
+    # The title is the content that will be rendered within a link to the
+    # resource. There are two main ways to set the content for the title
+    #
+    # First, you can pass in a method to be called on your
+    # resource. For example:
+    #
+    #   index :as => :blog do
+    #     title :a_method_to_call
+    #   end
+    #
+    # This will result in the title of the post being the return value of
+    # #a_method_to_call
+    #
+    # Second, you can pass a block to the tile option which will then be
+    # used as the contents fo the title. The resource being rendered
+    # is passed in to the block. For Example:
+    #
+    #   index :as => :blog do
+    #     title do |post|
+    #       span post.title, :class => 'title'
+    #       span post.created_at, :class => 'created_at'
+    #     end
+    #   end
+    #
+    # == Post Body
+    #
+    # The body is rendered underneath the title of each post. The same two
+    # style of options work as the Post Title above.
+    #
+    # Call a method on the resource as the body:
+    #
+    #   index :as => :blog do
+    #     title :my_title
+    #     body :my_body # Return value of #my_body will be the body
+    #   end
+    #
+    # Or, render a block as the body:
+    #
+    #   index :as => :blog do
+    #     title :my_title
+    #     body do |post|
+    #       div truncate(post.title)
+    #       div :class => 'meta' do
+    #         span "Post in #{post.categories.join(', ')}"
+    #       end
+    #     end
+    #   end
+    #
     class IndexAsBlog < ActiveAdmin::Component
 
       def build(page_config, collection)
@@ -14,16 +75,6 @@ def build(page_config, collection)
       end
 
       # Setter method for the configuration of the title
-      #
-      #   index :as => :blog do
-      #     title :a_method_to_call #=> Calls #a_method_to_call on the resource
-      #
-      #     # OR
-      #
-      #     title do |post|
-      #       post.a_method_to_call
-      #     end
-      #   end
       def title(method = nil, &block)
         if block_given? || method
           @title = block_given? ? block : method
@@ -33,17 +84,6 @@ def title(method = nil, &block)
 
       # Setter method for the configuration of the body
       #
-      #   index :as => :blog do
-      #     title :my_title
-      #
-      #     body :a_method_to_call #=> Calls #a_method_to_call on the resource
-      #
-      #     # OR
-      #
-      #     title do |post|
-      #       post.a_method_to_call
-      #     end
-      #   end
       def body(method = nil, &block)
         if block_given? || method
           @body = block_given? ? block : method