doc: Spell checking, edit links

michielklonhammer · Sep 25, 2012 · fed9032 · fed9032
1 parent cdf8122
commit fed9032
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 9 deletions.
diff --git a/doc/dev/codestyle.rst b/doc/dev/codestyle.rst
@@ -3,15 +3,15 @@ Code style conventions
 
 .. note:: 
    As these conventions were established only after a large
-   part of the codebase has been written, the code style described here
+   part of the code base has been written, the code style described here
    is not yet in effect in all parts of the Zotonic code base. We're
    trying to gradually adapt to it, however.
 
 
 Indenting Erlang code
 ---------------------
 
-We use the "Emacs-style" indenting (using erlang-mode provided with the 
+We use the "Emacs-style" indenting (using ``erlang-mode`` provided with the 
 Erlang distribution). This indenting style seems to be a convention in much
 of the Erlang world.
 
@@ -34,7 +34,7 @@ of code shorter than 80 characters.
 Writing Commit Messages
 -----------------------
 
-### taken from rebar's readme, https://github.com/basho/rebar; I find those quite sensible. ###
+### taken from rebar's README, https://github.com/basho/rebar; I find those quite sensible. ###
 
 Structure your commit message like this::
 
@@ -51,7 +51,7 @@ Structure your commit message like this::
 
 *  When your commit fixes a bug on github, add `Fixes #1545` on a separate line below the description.
 
-Notice the empty line preceeding the longer description.
+Notice the empty line preceding the longer description.
 
 
 Atomicity
@@ -60,3 +60,5 @@ Atomicity
 * Break up logical changes into separate commits.
 
 * Make whitespace changes separately.
+
+`Edit <https://github.com/zotonic/zotonic/edit/master/doc/dev/codestyle.rst>`_
diff --git a/doc/dev/contributing.rst b/doc/dev/contributing.rst
@@ -3,7 +3,7 @@ Contributing source code
 
 We encourage contributions to Zotonic from the community!
 
-1. Fork the `zotonic` repository on Github (at https://github.com/zotonic/zotonic).
+1. Fork the ``zotonic`` repository on Github (at https://github.com/zotonic/zotonic).
 
 2. Clone your fork or add the remote if you already have a clone of
    the repository::
@@ -29,3 +29,6 @@ We encourage contributions to Zotonic from the community!
 6. A Zotonic committer will review your patch and merge it into the
    main repository or send you feedback. The pull request page on
    github is the main place to discuss the code and related topics.
+
+
+`Edit <https://github.com/zotonic/zotonic/edit/master/doc/dev/contributing.rst>`_
diff --git a/doc/dev/documentation.rst b/doc/dev/documentation.rst
@@ -13,6 +13,4 @@ request.
 However, for small changes, typo's, et cetera, Github provides a nice
 edit button which you can use to edit these ``.rst`` files.
 
-**FIXME** -- generate edit links for each RST file!, like this:
-
 `Edit <https://github.com/zotonic/zotonic/edit/master/doc/dev/documentation.rst>`_
diff --git a/doc/dev/filing_issues.rst b/doc/dev/filing_issues.rst
@@ -19,14 +19,17 @@ In the issues, please state the nature of the problem in a clear and
 reproducible way.
 
 Try summarizing the problem in a single sentence and use that as the
-issue title. In the textarea below, please elaborate on the issue,
+issue title. In the text area below, please elaborate on the issue,
 adding the relevant log sections, etc.
 
 Please also state the following:
 
 * Zotonic version you're using
-* Whether you are running zotonic from git or from a downloaded release
+* Whether you are running Zotonic from git or from a downloaded release
 * Operating system
 * Erlang release
 * ... anything that comes to mind that might be relevant, really.    
 
+
+`Edit <https://github.com/zotonic/zotonic/edit/master/doc/dev/filing_issues.rst>`_
+
diff --git a/doc/dev/index.rst b/doc/dev/index.rst
@@ -11,3 +11,7 @@ Topics:
    contributing
    documentation
 
+
+
+`Edit <https://github.com/zotonic/zotonic/edit/master/doc/dev/index.rst>`_
+