Skip to content
This repository was archived by the owner on Mar 2, 2026. It is now read-only.

Commit 55d1356

Browse files
docs: add upgrading section to index of documentation (#248)
* 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>
1 parent 6a8cbdd commit 55d1356

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ API Reference
1919
types
2020
admin_client
2121

22+
Migration Guide
23+
---------------
24+
25+
See the guide below for instructions on migrating to the 2.x release of this library.
26+
27+
.. toctree::
28+
:maxdepth: 2
29+
30+
UPGRADING
2231

2332
Changelog
2433
---------

0 commit comments

Comments
 (0)