Documnetation overhaul 2

AUTHORS.md

@@ -169,6 +169,7 @@
 - Tom Forbes ([@orf](https://github.com/orf))
 - Xie Yanbo ([@xyb](https://github.com/xyb))
 - Maxim Ivanov ([@ivanovmg](https://github.com/ivanovmg))
+- Jens Klein ([@jensens](https://github.com/jensens))
 
 ## Backers
 

CODE_OF_CONDUCT.md

@@ -1,5 +1,4 @@
 # Code of Conduct
 
-Everyone interacting in the Cookiecutter project's codebases, issue trackers,
-chat rooms, and mailing lists is expected to follow the
-[PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
+Everyone interacting in the Cookiecutter project's codebases and documentation is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
+This includes, but is not limited to, issue trackers, chat rooms, mailing lists, and other virtual or in real life communication.

README.md

@@ -8,8 +8,7 @@
 [![docs](https://readthedocs.org/projects/cookiecutter/badge/?version=latest)](https://readthedocs.org/projects/cookiecutter/?badge=latest)
 [![Code Quality](https://img.shields.io/scrutinizer/g/cookiecutter/cookiecutter.svg)](https://scrutinizer-ci.com/g/cookiecutter/cookiecutter/?branch=master)
 
-A command-line utility that creates projects from **cookiecutters** (project templates),
-e.g. creating a Python package project from a Python package project template.
+A command-line utility that creates projects from **cookiecutters** (project templates), e.g. creating a Python package project from a Python package project template.
 
 - Documentation: [https://cookiecutter.readthedocs.io](https://cookiecutter.readthedocs.io)
 - GitHub: [https://github.com/cookiecutter/cookiecutter](https://github.com/cookiecutter/cookiecutter)
@@ -149,9 +148,10 @@ You are almost not limited in topics amount, use it!
 These Cookiecutters are maintained by the cookiecutter team:
 
 - [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage):
-  [@audreyfeldroy's](https://github.com/audreyfeldroy) ultimate Python package project template.
+  ultimate Python package project template by [@audreyfeldroy's](https://github.com/audreyfeldroy).
 - [cookiecutter-django](https://github.com/pydanny/cookiecutter-django):
-  A bleeding edge Django project template with Bootstrap 4, customizable users app, starter templates, working user registration, celery setup, and much more.
+  a framework for jumpstarting production-ready Django projects quickly.
+  It is bleeding edge with Bootstrap 5, customizable users app, starter templates, working user registration, celery setup, and much more.
 - [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin):
   Minimal Cookiecutter template for authoring [pytest](https://docs.pytest.org/) plugins that help you to write better programs.
 
@@ -164,8 +164,8 @@ Stuck? Try one of the following:
 
 - See the [Troubleshooting](https://cookiecutter.readthedocs.io/en/latest/troubleshooting.html) page.
 - Ask for help on [Stack Overflow](https://stackoverflow.com/questions/tagged/cookiecutter).
-- You are strongly encouraged to
-  [file an issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen) about the problem, even if it's just "I can't get it to work on this cookiecutter" with a link to your cookiecutter.
+- You are strongly encouraged to [file an issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen) about the problem.
+  Do it even if it's just "I can't get it to work on this cookiecutter" with a link to your cookiecutter.
   Don't worry about naming/pinpointing the issue properly.
 - Ask for help on [Discord](https://discord.gg/9BrxzPKuEW) if you must (but please try one of the other options first, so that others can benefit from the discussion).
 
@@ -177,48 +177,44 @@ Development on Cookiecutter is community-driven:
 - Connect with other Cookiecutter contributors and users on [Discord](https://discord.gg/9BrxzPKuEW)
   (note: due to work and other commitments, a core committer might not always be available)
 
-Encouragement is unbelievably motivating. If you want more work done on
-Cookiecutter, show support:
+Encouragement is unbelievably motivating.
+If you want more work done on Cookiecutter, show support:
 
 - Thank a core committer for their efforts.
 - Star [Cookiecutter on GitHub](https://github.com/cookiecutter/cookiecutter).
 - [Support this project](#support-this-project)
 
 Got criticism or complaints?
 
-- [File an issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)
-  so that Cookiecutter can be improved. Be friendly and constructive about what
-  could be better. Make detailed suggestions.
-- **Keep us in the loop so that we can help.** For example, if you are
-  discussing problems with Cookiecutter on a mailing list,
-  [file an issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)
-  where you link to the discussion thread and/or cc at least 1 core committer on the email.
-- Be encouraging. A comment like "This function ought to be rewritten like this"
-  is much more likely to result in action than a comment like "Eww, look how bad
-  this function is."
+- [File an issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen) so that Cookiecutter can be improved.
+  Be friendly and constructive about what could be better.
+  Make detailed suggestions.
+- **Keep us in the loop so that we can help.**
+  For example, if you are discussing problems with Cookiecutter on a mailing list, [file an issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen) where you link to the discussion thread and/or cc at least 1 core committer on the email.
+- Be encouraging.
+  A comment like "This function ought to be rewritten like this" is much more likely to result in action than a comment like "Eww, look how bad this function is."
 
 Waiting for a response to an issue/question?
 
-- Be patient and persistent. All issues are on the core committer team's radar
-  and will be considered thoughtfully, but we have a lot of issues to work through.
+- Be patient and persistent. All issues are on the core committer team's radar and will be considered thoughtfully, but we have a lot of issues to work through.
   If urgent, it's fine to ping a core committer in the issue with a reminder.
 - Ask others to comment, discuss, review, etc.
 - Search the Cookiecutter repo for issues related to yours.
 - Need a fix/feature/release/help urgently, and can't wait?
-  [@audreyfeldroy](https://github.com/audreyfeldroy) is available for hire for consultation
-  or custom development.
+  [@audreyfeldroy](https://github.com/audreyfeldroy) is available for hire for consultation or custom development.
 
 ## Support This Project
 
-This project is run by volunteers. Shortly we will be providing means for
-organizations and individuals to support the project.
+This project is run by volunteers.
+Shortly we will be providing means for organizations and individuals to support the project.
 
 ## Code of Conduct
 
-Everyone interacting in the Cookiecutter project's codebases, issue trackers,
-chat rooms, and mailing lists is expected to follow the
-[PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
+Everyone interacting in the Cookiecutter project's codebases and documentation is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
+This includes, but is not limited to, issue trackers, chat rooms, mailing lists, and other virtual or in real life communication.
 
 ## Creator / Leader
 
 This project was created and is led by [Audrey Roy Greenfeld](https://github.com/audreyfeldroy).
+
+She is supported by a team of maintainers.

docs/cookiecutter.rst

@@ -1,8 +1,10 @@
+===
 API
 ===
 
-Submodules
-----------
+
+This is the Cookiecutter modules API documentation.
+
 
 cookiecutter.cli module
 -----------------------
@@ -132,7 +134,6 @@ cookiecutter.zipfile module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/index.rst

@@ -6,7 +6,7 @@
 Cookiecutter: Better Project Templates
 ======================================
 
-Cookiecutter creates projects from project templates, e.g. Python package projects.
+Cookiecutter creates projects from **cookiecutters** (project templates), e.g. Python package projects from Python package temnplates.
 
 Basics
 ------

docs/installation.rst

@@ -22,7 +22,7 @@ Alternatively on macOS, you can use the `homebrew <http://brew.sh/>`_ package ma
 
 .. code-block:: bash
 
-    $ brew install python3
+    brew install python3
 
 
 Adjust your path
@@ -73,27 +73,27 @@ At the command line:
 
 .. code-block:: bash
 
-    $ python3 -m pip install --user cookiecutter
+    python3 -m pip install --user cookiecutter
 
 Or, if you do not have pip:
 
 .. code-block:: bash
 
-    $ easy_install --user cookiecutter
+    easy_install --user cookiecutter
 
 Though, pip is recommended, easy_install is deprecated.
 
 Or, if you are using conda, first add conda-forge to your channels:
 
 .. code-block:: bash
 
-    $ conda config --add channels conda-forge
+    conda config --add channels conda-forge
 
 Once the conda-forge channel has been enabled, cookiecutter can be installed with:
 
 .. code-block:: bash
 
-    $ conda install cookiecutter
+    conda install cookiecutter
 
 Alternate installations
 -----------------------
@@ -102,13 +102,13 @@ Alternate installations
 
 .. code-block:: bash
 
-    $ brew install cookiecutter
+    brew install cookiecutter
 
 **Pipx (Linux, OSX and Windows):**
 
 .. code-block:: bash
 
-    $ pipx install cookiecutter
+    pipx install cookiecutter
 
 
 Upgrading
@@ -130,12 +130,12 @@ Or with pip:
 
 .. code-block:: bash
 
-    $ python3 -m pip install --upgrade cookiecutter
+    python3 -m pip install --upgrade cookiecutter
 
 Upgrade Cookiecutter either with easy_install (deprecated):
 
 .. code-block:: bash
 
-    $ easy_install --upgrade cookiecutter
+    easy_install --upgrade cookiecutter
 
 Then you should be good to go.

docs/overview.rst

@@ -27,9 +27,8 @@ This is a directory structure for a simple cookiecutter::
 
 You must have:
 
-- A `cookiecutter.json` file.
-- A `{{ cookiecutter.project_name }}/` directory, where
-  `project_name` is defined in your `cookiecutter.json`.
+- A ``cookiecutter.json`` file.
+- A ``{{ cookiecutter.project_name }}/`` directory, where ``project_name`` is defined in your ``cookiecutter.json``.
 
 Beyond that, you can have whatever files/directories you want.