Add release notes to docs

These release notes are very high level descriptions of added features
to the project. Detailed changelogs will still be in the CHANGELOG.md,
the version tags, and the releases on Github.

docs/index.rst

@@ -21,6 +21,7 @@ instructions for trying Liquidprompt temporarily.
    config
    theme
    functions
+   release-notes
    upgrading
 
 Indices and tables

docs/release-notes.rst

@@ -0,0 +1,17 @@
+Release Notes
+*************
+
+The release documents here are a brief overview of the most important changes in
+a release. See the `Changelog`_ for a full description of what has changed.
+
+For a full description of what a user needs to do to upgrade, see
+:doc:`upgrading`.
+
+.. _`Changelog`: https://github.com/nojhan/liquidprompt/blob/master/CHANGELOG.md
+
+.. toctree::
+   :maxdepth: 2
+   :reversed:
+
+   release-notes/v1.12
+   release-notes/v2.0

docs/release-notes/v1.12.rst

@@ -0,0 +1,40 @@
+Version 1.12 Release Notes
+**************************
+
+Most of the changes in 1.12 are accumulated bug fixes, but a few features made
+it in as well.
+
+.. contents::
+   :local:
+
+Runtime Bell
+============
+
+A new feature, similar to the displayed last command runtime, is to ring the
+terminal bell when the running command exits, if the runtime was over a
+threshold. This can be used to notify when a long running command has finished.
+
+See the :attr:`LP_RUNTIME_BELL` and :attr:`LP_RUNTIME_BELL_THRESHOLD` config
+options.
+
+Permissions Mark
+================
+
+The ``:`` mark between the hostname and the current directory was a constant
+string, but now it has a config option: :attr:`LP_MARK_PERM`.
+
+Preset Color Aliases
+====================
+
+The ``5`` value of the basic colors is often named "magenta", but in
+Liquidprompt it has always been "purple", and the bold version is "pink".
+
+To make the options more standard, an alias for ``PURPLE`` is ``MAGENTA``, and
+``PINK`` now has aliases of ``BOLD_PURPLE`` and ``BOLD_MAGENTA``.
+
+Speed Improvements
+==================
+
+Improvements to the startup process have cut startup times by at least 30% in
+all cases.
+

docs/release-notes/v2.0.rst

@@ -0,0 +1,74 @@
+Version 2.0 Release Notes
+*************************
+
+Version 2.0 had to break a few eggs, but got a lot of reward out of it. This
+release is full of new features and improvements.
+
+.. contents::
+   :local:
+
+Speed Improvements
+==================
+
+By removing subshells, ``exec``, and other ``fork`` ing calls, the whole project
+has seen incredible speed improvements, anywhere from 1.5 to 10 times as fast.
+
+Theme Engine
+============
+
+Thanks to the new data source functions (see below), themes are able to change
+*everything* about how the prompt is displayed, instead of only color and
+element order.
+See :doc:`../theme`.
+
+Example Themes
+==============
+
+Liquidprompt now ships with some example themes showcasing how the new theme
+engine works. They are also fulling working themes that you can use as your
+daily drivers.
+See :doc:`../theme/included`.
+
+Data Sources
+============
+
+To power the themes, all of the data sources in Liquidprompt have been broken
+out into individual data functions that can be called by themes. They are also
+documented in detail in :doc:`../functions/data`.
+
+Version Control Interface
+=========================
+
+Before, each version control provider had its own function for displaying
+repository information. Now there is a unifying interface over all VCS providers
+that themes can use to display any VCS provider the same as all the others.
+See :doc:`../functions/data/vcs`.
+
+The default theme now uses this interface to display all VCS providers in the
+same way (similar to how Git was displayed before).
+See :doc:`../functions/theme`.
+
+Version Control Tracking updates without directory change
+=========================================================
+
+Before, if ``git init`` or similar was run in a directory, Liquidprompt would
+not display any repository information until the current directory was changed.
+Thanks to the speed improvements, Liquidprompt now checks for a repository at
+each prompt, while still being faster than version 1.12.
+
+Activate Function
+=================
+
+Before, when changing the user config file, a user needed to source
+``liquidprompt`` again to load their config changes (or ``exec bash`` or ``exec
+zsh``). Now that all of the initialization code has been refactored into
+:attr:`lp_activate`, running :attr:`lp_activate` after modifiying the config
+file or installing a new feature dependent program like ``git`` is all that is
+needed!
+
+Documentation
+=============
+
+The often lacking README documentation has been re-written with Sphinx to make
+this much improved documentation source.
+

docs/upgrading.rst

@@ -7,5 +7,7 @@ If a version introduces breaking changes or deprecation notices, a detailed
 document describing what changes a user needs to make will be linked below.
 
 .. toctree::
+   :maxdepth: 2
+   :reversed:
 
    upgrading/v2.0