Fixed grammatical and stylistic issues in the documentation. (#320)

* Fixed grammatical errors and style issues in index.rst

* Fixed grammatical errors

Also made some changes to improve consistency in writing style.

* Update CONTRIBUTORS.txt

CONTRIBUTORS.txt

@@ -21,4 +21,5 @@ Vladyslav Ovchynnykov
 Toufeeq Ockards
 Rafael Cascalho
 Everone Graham
-Batul Salhab
+Batul Salhab
+Eli Armstrong

create_aio_app/template/{{cookiecutter.project_name}}/docs/source/index.rst

@@ -7,10 +7,10 @@ The aiohttp boilerplate. A quick start for your aiohttp application.
 ====================================================================
 
 What is a `create aio app`? This project is designed to quickly and simply
-creating a web application based on `aiohttp` with use best practices.
+create a web application based on `aiohttp` using best practices.
 
-A `create aio app` provide testing, documentation, deploying and a lot of
-helpful boilerplate code for quickly start with `aiohttp`.
+A `create aio app` provides testing, documentation, deploying and a lot of
+other helpful boilerplate code for quickly start with `aiohttp`.
 
 .. image:: https://raw.githubusercontent.com/aio-libs/create-aio-app/master/assets/assets.png
    :align: center
@@ -19,7 +19,7 @@ helpful boilerplate code for quickly start with `aiohttp`.
 Requirements
 ------------
 
-For start with `create aio app` you need to have:
+To start with `create aio app` you need to have:
 
    - docker
    - docker-compose
@@ -47,7 +47,7 @@ Features
          <a href="https://pytest.readthedocs.io/en/latest/" rel="nofollow">
             pytest
          </a>
-         - for run unit tests
+         - for running unit tests
        </li>
        <li>
          <a href="https://flake8.readthedocs.io/en/latest/" rel="nofollow">
@@ -59,13 +59,13 @@ Features
          <a href="https://trafaret.readthedocs.io/en/latest/" rel="nofollow">
             trafaret
          </a>
-         - for validation input data
+         - for validating input data
        </li>
        <li>
          <a href="https://github.com/aio-libs/aiohttp-devtools" rel="nofollow">
             aio devtools
          </a>
-         - helpful tool for develop
+         - helpful tool for development
        </li>
        <li>
          <a href="https://github.com/aio-libs/aiohttp-debugtoolbar" rel="nofollow">
@@ -77,13 +77,13 @@ Features
          <a href="https://www.postgresql.org/" rel="nofollow">
             postgres
          </a>
-         - storage
+         - for storage
        </li>
        <li>
          <a href="https://alembic.sqlalchemy.org/en/latest/tutorial.html" rel="nofollow">
             alembic
          </a>
-         - tool for create migration
+         - for migration
        </li>
        <li>
          <a href="https://www.sqlalchemy.org/" rel="nofollow">

create_aio_app/template/{{cookiecutter.project_name}}/docs/source/pages/aiohttp_quick_start.rst

@@ -20,7 +20,7 @@ Usage
 
     create-aio-app my_project
 
-If you want to use interactive mode enter the next command:
+If you want to use interactive mode, enter the following command:
 
 .. code-block:: bash
 

create_aio_app/template/{{cookiecutter.project_name}}/docs/source/pages/documentation.rst

@@ -1,19 +1,19 @@
 Documentation
 =============
 
-The best thing you can do for future self is to write both tests and
-documentation about your project. This section explains how to
+The best thing you can do for future self and fellow contributors is to write
+both tests and documentation about your project. This section explains how to
 structure and organize documentation in your project.
 
 Structure
 ---------
 
-We use the next structure:
+We use the following structure:
 
    - **pages/** -
-     the directory for all `*.rst` files about the boilerplate.
+     The directory for all `*.rst` files about the boilerplate.
    - **project/** -
-     this directory is for `*.rst` files associated with your project
+     This directory is for `*.rst` files associated with your project
      (this can include auto-generated docs, business logic, etc.)
 
 All new files should be added to *index.rst*.
@@ -34,13 +34,13 @@ Read more:
          <a href="http://www.sphinx-doc.org/en/master/usage/quickstart.html" rel="nofollow">
             Sphinx
          </a>
-         - the official documentation for sphinx
+         - official sphinx documentation
        </li>
        <li>
-         <a href="https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html" rel="nofollow">
+         <a hef="https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html" rel="nofollow">
             Documentation style guide
          </a>
-        - the recommended style guide
+        - recommended style guide
        </li>
        <li>
          <a href="https://github.com/openstack/doc8" rel="nofollow">

create_aio_app/template/{{cookiecutter.project_name}}/docs/source/pages/tests.rst

@@ -40,7 +40,7 @@ To run mypy use this command:
 
     make mypy
 
-Settings for mypy resides inside the mypy.ini file.
+Settings for mypy reside inside the mypy.ini file.
 
 Read more:
 ----------
@@ -52,12 +52,12 @@ Read more:
          <a href="https://docs.pytest.org/en/latest/contents.html" rel="nofollow">
             pytest
          </a>
-         - the official documentation for pytest
+         - official documentation for pytest
        </li>
        <li>
          <a href="https://mypy.readthedocs.io/en/latest/" rel="nofollow">
             mypy
          </a>
-         - the official documentation for mypy
+         - official documentation for mypy
        </li>
     </ul>