From 3f0aa6a704141d3a5d0a1f7b69420b03629e7db5 Mon Sep 17 00:00:00 2001
From: Jonathan Thomas <jonathan@openshot.org>
Date: Thu, 12 Dec 2024 00:18:44 -0600
Subject: [PATCH] Adding documentation for the Recovery menu.

---
 doc/main_window.rst |  1 +
 doc/preferences.rst | 33 ++++++++++++++++++++++++++-------
 2 files changed, 27 insertions(+), 7 deletions(-)

diff --git a/doc/main_window.rst b/doc/main_window.rst
index 6ed5ef65e..9a355af12 100644
--- a/doc/main_window.rst
+++ b/doc/main_window.rst
@@ -223,6 +223,7 @@ are renamed and/or rearranged.
        - :guilabel:`New Project` Create a blank new project.
        - :guilabel:`Open Project` Open an existing project.
        - :guilabel:`Recent Projects` Access recently opened projects.
+       - :guilabel:`Recovery` Restore a previously saved version of your current project.
        - :guilabel:`Save Project` Save the current project.
        - :guilabel:`Import Files` Import media files into the project.
        - :guilabel:`Choose Profile` Select a project profile (*i.e. 1080p @ 30fps, 720p @ 24fps, ...*).
diff --git a/doc/preferences.rst b/doc/preferences.rst
index df695d229..0fa17d3e7 100644
--- a/doc/preferences.rst
+++ b/doc/preferences.rst
@@ -111,21 +111,40 @@ Autosave
 
 .. image:: images/preferences-3-autosave.jpg
 
-Autosave is a saving function in OpenShot which automatically saves the current changes to your project after
+Autosave is a feature in OpenShot which automatically saves the current changes to your project after
 a specific number of minutes, helping to reduce the risk or impact of data loss in case of a crash, freeze
 or user error.
 
+.. table::
+   :widths: 30 15
+
+   =====================================  ==================
+   Setting                                Default
+   =====================================  ==================
+   Enable Autosave                        Enabled
+   Autosave Interval (minutes)            3
+   History Limit (# of undo/redo)         15
+   Recovery Limit (# of project copies)   30
+   =====================================  ==================
+
 Recovery
 """"""""
 
-Before each save, a copy of the current project is created in a recovery folder, to further
+Before each save, a copy of the current project is saved in the recovery folder, to further
 reduce the risk of data loss. The recovery folder is located at ``~/.openshot_qt/recovery/`` or
-``C:\Users\USERNAME\.openshot_qt\recovery``. If you need to recover a corrupt or broken ``*.osp``
+``C:\Users\USERNAME\.openshot_qt\recovery``.
+
+To recover a corrupt or broken ``*.osp`` project file, use the :guilabel:`File->Recovery`
+menu on the main window after opening your project. If available, a list of matching project versions from
+the recovery folder are listed in chronological order (most recent one at the top). This will
+automatically rename your current project file to "{project-name}-{time}-backup.osp", and
+replace it with the recovery project file. You can repeat this process until you find
+the correct recovery project.
+
+To **manually** recover a corrupt or broken ``*.osp``
 project file, please find the most recent copy in the recovery folder, and copy/paste the file
-in your original project folder location (i.e. the folder that contains your broken project), and then
-**open** this recovered project file in OpenShot. Many versions of each project are stored in the
-recovery folder, and if you still have issues with the recovered ``*.osp`` file, you can repeat this
-process with older versions contained in the recovery folder.
+into your original project folder location (i.e. the folder that contains your broken project), and then
+**open** this recovered project file in OpenShot.
 
 .. _preferences_cache_ref: