85c5e6d231b3 initial-docs

docs: minor tweaks
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Tue, 15 Jun 2010 20:30:23 -0400
parents 684aad6ac503
children 773e2317f086
branches/tags initial-docs
files docs/index.rst docs/licensing.rst docs/overview.rst

Changes

--- a/docs/index.rst	Tue Jun 15 20:10:00 2010 -0400
+++ b/docs/index.rst	Tue Jun 15 20:30:23 2010 -0400
@@ -7,7 +7,7 @@
 =======================
 
 hg-review is a `Mercurial <http://hg-scm.org>`_ extension for performing
-distributed code review.
+distributed `code review <http://en.wikipedia.org/wiki/Code_review>`_.
 
 Quickstart
 ----------
@@ -28,18 +28,14 @@
 already got one -- hg-review uses itself for code review. 
 
 ``cd`` into the directory you cloned hg-review to and initialize the review
-data::
+data, then start the web interface::
 
     cd hg-review
     hg review --init
-
-Start the web interface::
-
     hg review --web
 
-Open http://localhost:8080/ in your browser of choice and poke around.
-
-Check out the :doc:`Overview </overview>` when you're ready to learn more.
+Open http://localhost:8080/ in your browser of choice and poke around. Check
+out the :doc:`Overview </overview>` when you're ready to learn more.
 
 User's Guide
 ------------
--- a/docs/licensing.rst	Tue Jun 15 20:10:00 2010 -0400
+++ b/docs/licensing.rst	Tue Jun 15 20:30:23 2010 -0400
@@ -7,4 +7,4 @@
 
 If you want to create a program that works with hg-review you should look at
 `Mercurial's License FAQ page <http://mercurial.selenic.com/wiki/License>`_ to
-learn about how this may affect you.
+learn about how this might affect you.
--- a/docs/overview.rst	Tue Jun 15 20:10:00 2010 -0400
+++ b/docs/overview.rst	Tue Jun 15 20:30:23 2010 -0400
@@ -46,7 +46,7 @@
 
 You should read over the :doc:`concepts </concepts>` documentation to make sure
 you know how hg-review works, and the :doc:`web interface </webui>`
-documentation for a quick tour of how to use the web ui.
+documentation for a quick tour of how to use the web UI.
 
 Projects without Existing Code Reviews
 ''''''''''''''''''''''''''''''''''''''
@@ -66,7 +66,7 @@
 
     hg review --init --remote-path URL
 
-The ``URL`` should be the URL of the review repo you just created.
+The ``URL`` should be the *public* URL of the review repo you just created.
 
 This will create a local review data repo for you, as well as an ``.hgreview``
 file in your project. You need to commit this ``.hgreview`` file to your
@@ -80,7 +80,7 @@
 
 You should read over the :doc:`concepts </concepts>` documentation to make sure
 you know how hg-review works, and the :doc:`web interface </webui>`
-documentation for a quick tour of how to use the web ui.
+documentation for a quick tour of how to use the web UI.
 
 Reporting Bugs
 --------------