Skip to content

Commit

Permalink
docs: add upgrading section to index of documentation (#248)
Browse files Browse the repository at this point in the history
* docs: adds UPGRADING.md, not to readme, to help inform users about migration to v2

* docs: erroneous version number

* Update UPGRADING.md

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>

* docs: clarify enums statement

* docs: add migration section to docs index

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
  • Loading branch information
crwilcox and BenWhitehead committed Nov 6, 2020
1 parent 6a8cbdd commit 55d1356
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/index.rst
Expand Up @@ -19,6 +19,15 @@ API Reference
types
admin_client

Migration Guide
---------------

See the guide below for instructions on migrating to the 2.x release of this library.

.. toctree::
:maxdepth: 2

UPGRADING

Changelog
---------
Expand Down

0 comments on commit 55d1356

Please sign in to comment.