More docs tweaks

respondcreate · Apr 22, 2015 · 2e56b79 · 2e56b79
1 parent 5cc7b0d
commit 2e56b79
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 17 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -1 +1,6 @@
 .wy-nav-content{max-width:1200px;}
+
+p.intro-paragraph {
+    font-size:20px;
+    line-height:32px;
+}
diff --git a/docs/drf_integration.rst b/docs/drf_integration.rst
@@ -88,10 +88,10 @@ And here's what it would look like serialized:
         'name_first': 'John',
         'name_last': 'Doe',
         'headshot': {
-            'full_size': '/media/headshots/john_doe_headshot.jpg',
-            'thumbnail': '/media/headshots/john_doe_headshot-thumbnail-400x400.jpg',
-            'medium_square_crop': '/media/headshots/john_doe_headshot-crop-c0-5__0-5-400x400.jpg',
-            'small_square_crop': '/media/headshots/john_doe_headshot-crop-c0-5__0-5-50x50.jpg',
+            'full_size': 'http://api.yoursite.com/media/headshots/john_doe_headshot.jpg',
+            'thumbnail': 'http://api.yoursite.com/media/headshots/john_doe_headshot-thumbnail-400x400.jpg',
+            'medium_square_crop': 'http://api.yoursite.com/media/headshots/john_doe_headshot-crop-c0-5__0-5-400x400.jpg',
+            'small_square_crop': 'http://api.yoursite.com/media/headshots/john_doe_headshot-crop-c0-5__0-5-50x50.jpg',
         }
     }
 

diff --git a/docs/in_a_nutshell.rst b/docs/in_a_nutshell.rst
@@ -1,7 +1,7 @@
 In a Nutshell
 =============
 
-You're probably using an ``ImageField``.
+You're probably using an `ImageField <https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.ImageField>`_.
 
 .. code-block:: python
 
@@ -50,7 +50,7 @@ Create Images Wherever You Need Them
 
 A ``VersatileImageField`` can create new images on-demand **both in templates and the shell**.
 
-Let's make a thumbnail image:
+Let's make a thumbnail image that would fit within a 200px by 200px area:
 
 .. list-table::
    :header-rows: 1
@@ -89,22 +89,16 @@ You can use it to create cropped images, too:
 Custom, Per-Image Cropping
 --------------------------
 
-Don't worry! ``VersatileImageField`` can deal with undesirable crops via it's :doc:`Primary Point of Interest (PPOI)</specifying_ppoi>` functionality:
+Don't worry! ``VersatileImageField`` ships with a handy admin-compatible widget that you can use to specify an image's :doc:`Primary Point of Interest (PPOI)</specifying_ppoi>` by clicking on it.
+
+*Note the translucent red square underneath the mouse cursor in the image below:*
 
 .. list-table::
    :header-rows: 1
 
    * - Admin Widget
      - Image
-   * - **Default:**
-
-       .. figure:: /_static/images/ppoi-default.jpg
-            :alt: Centered PPOI
-     - .. figure:: /_static/images/the-dowager-countess-crop-c0-5__0-5-400x400.jpg
-            :alt: Absolute Center Crop
-   * - **Adjusted:**
-
-       .. figure:: /_static/images/ppoi-adjusted.jpg
+   * - .. figure:: /_static/images/ppoi-adjusted.jpg
             :alt: Centered PPOI
      - .. figure:: /_static/images/the-dowager-countess-crop-c0-44__0-22-400x400.jpg
             :alt: Custom PPOI Entered

diff --git a/docs/index.rst b/docs/index.rst
@@ -34,7 +34,11 @@ Welcome to django-versatileimagefield's documentation!
 
 ----
 
-``VersatileImageField`` is a drop-in replacement for django's ``ImageField`` that provides a flexible, intuitive and easily-extensible interface for creating new images from the one assigned to the field. For an overview of why you should be using it, :doc:`click here </in_a_nutshell>`.
+.. rst-class:: intro-paragraph
+
+  A drop-in replacement for django's ``ImageField`` that provides a flexible, intuitive and easily-extensible interface for creating new images from the one assigned to the field.
+
+  For a quick overview of why you should be using it, :doc:`click here </in_a_nutshell>`.
 
 
 Table of Contents