diff --git a/docs-sidebar.js b/docs-sidebar.js index 2ba6b37944..84a44256e0 100644 --- a/docs-sidebar.js +++ b/docs-sidebar.js @@ -211,6 +211,10 @@ const sidebars = { type: 'category', label: 'Experimental features', collapsed: true, + link: { + type: 'doc', + id: 'experimental/index', + }, items: [ 'experimental/goal-templates', 'experimental/monthly-cleanup', diff --git a/docs/experimental/index.md b/docs/experimental/index.md new file mode 100644 index 0000000000..aba7c83993 --- /dev/null +++ b/docs/experimental/index.md @@ -0,0 +1,25 @@ +# Experimental Features + +It can take a long time to fully develop and test new features. +In order to make development easier, and to allow users to give feedback, Actual has a system of `experimental features`. +These experimental features are generally opt-in. +If the user doesn't opt-in to enabling the feature there will be no change in user experience. + +These features are still in active development and therefore it is highly recommended to have a regular backup if you enable any of these features. + +## View and enable experimental features + +In order to view the currently available experimental features to to Settings -> Show advanced settings -> Experimental features. + +![Experimental features](/img/experimental/setting.png) + +You will need to agree to the disclaimer, and then you will be able to see the available experimental features. + +![available features](/img/experimental/available.png) + + + + + + + diff --git a/docs/settings/index.md b/docs/settings/index.md index 419a244d26..36230ef0cf 100644 --- a/docs/settings/index.md +++ b/docs/settings/index.md @@ -53,10 +53,5 @@ If you are experiencing bugs relating to split transactions and the “Reset bud ### Experimental Features -Be careful with this section; you might encounter irrecoverable errors if you enable these settings. But if you want to test out some bleeding-edge features, here's your place to do it. We _highly_ recommend backing up your budget before continuing, just in case. As of the [latest release](../releases.md), the current available experimental features are: - -- Monthly spending report -- [Goal templates](../experimental/goal-templates.md) -- Customizable reports page (dashboards) -- Rule action templating -- Scheduled transaction upcoming length adjustment +This section is where you can enable features that are still in development and testing. +See the [experimental feature documentation](../experimental) for more information. diff --git a/static/img/experimental/available.png b/static/img/experimental/available.png new file mode 100644 index 0000000000..ad8d93e089 Binary files /dev/null and b/static/img/experimental/available.png differ diff --git a/static/img/experimental/setting.png b/static/img/experimental/setting.png new file mode 100644 index 0000000000..1e5c2ad23a Binary files /dev/null and b/static/img/experimental/setting.png differ