73232396dd2b initial-docs

docs: style, formatting, wording
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 05 Jul 2010 23:59:05 -0400
parents 98c12a5d5aec
children 544c6c7b7603
branches/tags initial-docs
files docs/concepts.rst docs/hgreview/static/review.css docs/hgreview/static/review.less review/static/style.less

Changes

--- a/docs/concepts.rst	Mon Jul 05 23:39:21 2010 -0400
+++ b/docs/concepts.rst	Mon Jul 05 23:59:05 2010 -0400
@@ -18,7 +18,7 @@
 just wrote. Often a second set of eyes can find problems you might not have
 seen, especially if that person has more experience than you.
 
-Unfortunately, this isn't always practical. You might work remotely with people
+Unfortunately this isn't always practical. You might work remotely with people
 thousands of miles away and not have a chance to simply turn around and say:
 "Hey, could you look at this?"
 
@@ -31,7 +31,7 @@
 Other Code Review Tools
 -----------------------
 
-There are a lot of "code review tools" out there.
+There are a lot of "code review tools" out there. 
 
 The primary author of hg-review has a lot of experience with `Atlassian
 Crucible <http://www.atlassian.com/software/crucible/>`_, but some other
@@ -73,11 +73,10 @@
 repository and can be pushed and pulled like any other type of data.
 
 This has several advantages, the biggest one being that you can review code
-while offline (while in a bus, plane, train or car, or example) without
-sacrificing any functionality.
+while offline without sacrificing any functionality.
 
-It also means that the full power of Mercurial, such as tracking history and
-signing changesets with GPG, can be brought to bear on the review data.
+It also means that the full power of Mercurial (such as tracking history and
+signing changesets with GPG) can be used on the review data.
 
 Review Data
 -----------
@@ -92,27 +91,25 @@
 * One or more lines of a specific file within a changeset.
 
 Signoffs, on the other hand, *always* apply to a changeset as a whole. Each
-person can have on signoff for any particular changeset (though they can edit
+person can have one signoff for any particular changeset (though they can edit
 their signoff later).
 
 Signoffs can be used for whatever purpose your project might find useful, but
-the author of hg-review recommends that they be used to mean:
+the author of hg-review recommends that signoffs of "yes" mean:
 
     I approve of this changeset and think it should make its way to production.
 
-for signoffs of "Yes" and: 
+And signoffs of "No" mean:
 
     I do not approve of this changeset and do not think it should make its way to
     production without another changeset on top of it that fixes the problems
     I have listed.
 
-for signoffs of "No."
-
 Signoffs of "neutral" might mean:
 
     This changeset doesn't really impact me, so I don't care.
 
-or perhaps:
+Or perhaps:
 
     I've looked at this code but don't have the expertise to provide a useful
     opinion.
@@ -127,8 +124,8 @@
 Let's say you have a project with a Mercurial repository in
 ``~/src/yourproject/`` and you'd like to start using hg-review with it.
 
-The first thing to understand is that Mercurial itself stores data about this
-local repository in ``~/src/yourproject/.hg/``, and that data is local to your
+The first thing to understand is that Mercurial stores data about this local
+repository in ``~/src/yourproject/.hg/``, and that data is local to your
 machine. It is never committed or tracked by Mercurial, but is instead used by
 the Mercurial program itself to work with your repository.
 
@@ -136,13 +133,13 @@
 It stores this repository in ``~/src/yourproject/.hg/review/``.
 
 Because this is inside of Mercurial's internal ``.hg`` directory of your
-project, changes to the review data (like comments and signoffs) won't be
-tracked by your project's repository.
+project changes to the review data (like comments and signoffs) won't be
+tracked in your project's repository.
 
-Instead, hg-review manages its own data in its own repository to avoid
-cluttering up your project's log with useless "added a comment"-type commits.
+hg-review manages its own data in its own repository to avoid cluttering up
+your project's log with useless "added a comment"-type commits.
 
 This structure means that you can ``cd`` into the review data repository itself
 and interact with it just as you would a normal Mercurial repository. You can
-``push`` and ``pull`` to and from other people, backout changesets, and do
+``push`` and ``pull`` to and from other people, backout changesets and do
 anything else you could with a normal Mercurial repository.
--- a/docs/hgreview/static/review.css	Mon Jul 05 23:39:21 2010 -0400
+++ b/docs/hgreview/static/review.css	Mon Jul 05 23:59:05 2010 -0400
@@ -3,6 +3,7 @@
   background-color: #f8f7e8;
   font-family: Georgia, serif;
   color: #222;
+  text-rendering: optimizeLegibility;
 }
 body a, html a {
   color: #b6410c;
--- a/docs/hgreview/static/review.less	Mon Jul 05 23:39:21 2010 -0400
+++ b/docs/hgreview/static/review.less	Mon Jul 05 23:59:05 2010 -0400
@@ -96,11 +96,24 @@
                 white-space: pre;
             }
             ul {
+                list-style-type: disc;
+
+                li {
+                    margin-left: 44px;
+                }
                 span.pre {
                     background-color: inherit;
                     border: none;
                     padding: 0;
                 }
+                li.toctree-l1 {
+                    list-style-type: none;
+                    margin-left: 0;
+                }
+                li.toctree-l2, li.toctree-l3 {
+                    list-style-type: none;
+                    margin-left: 30px;
+                }
             }
             a em {
                 font-style: normal;
--- a/review/static/style.less	Mon Jul 05 23:39:21 2010 -0400
+++ b/review/static/style.less	Mon Jul 05 23:59:05 2010 -0400
@@ -97,6 +97,7 @@
 html, body {
     background-color: @c-cream;
     background: @c-cream url('bg.png') top left repeat;
+    text-rendering: optimizeLegibility;
 }
 body {
     color: @c-dark;