diff --git a/docs/index.rst b/docs/index.rst index 1206ab0f5..f81419b02 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -57,8 +57,9 @@ Welcome to Red - Discord Bot's documentation! :maxdepth: 2 :caption: Changelogs: - changelog_3_1_0 + release_notes_3_2_0 changelog_3_2_0 + changelog_3_1_0 .. toctree:: :maxdepth: 2 diff --git a/docs/release_notes_3_2_0.rst b/docs/release_notes_3_2_0.rst new file mode 100644 index 000000000..0eeb8dcfc --- /dev/null +++ b/docs/release_notes_3_2_0.rst @@ -0,0 +1,50 @@ +.. v3.2.0 Release Notes + +################################## +Red DiscordBot 3.2.0 Release Notes +################################## + + +Please read the following prior to updating. + +- 3.2 comes with improvements which required breaking changes for 3rd party cogs + When you update to 3.2, your cogs may not be compatible if the author has not handled + the changes yet. + + +- 3.2 Requires python3.8.1 + This was done so that we could better handle some behavior which was not fixed for python3.7 + If you need help updating, our install docs will cover everything you need to know to update. + + .. note:: + + You may get a noticiation from the downloader cog about needing to refetch dependencies + This is expected, and it will walk you through everything and do as much as it can for you. + + +- 3.2 Dropped support for the Mongo Driver + + - If you were not using the mongo driver, this does not effect you. + - If you were using a 3rd party cog which required mongo, it still requires mongo + - If you were using mongo, prior to launching your instance, + you will need to run the following commands to convert + + .. code:: + + python -m pip install dnspython~=1.16.0 motor~=2.0.0 pymongo~=3.8.0 + redbot-setup convert [instancename] json + + +- 3.2 Comes with many feature upgrades. A brief high level list. + + - A metric ton of bugfixes + - Bot shutdown is handled significantly better + - Audio is significantly more powerful + - We've made it easier for cog creators to interact with the core bot APIs safely + - We've supplied cog creators with additional tools + + +.. note:: + + The full list of changes is much longer than we can include here, + but our changelog has the fine details.