Skip to content

A local-first personal finance app

Preview builds

Rich Howella44b21859ee5
diff --git a/docs/Developers/preview-builds.md b/docs/Developers/preview-builds.md
new file mode 100644
index 0000000000..a6f1629893
--- /dev/null
+++ b/docs/Developers/preview-builds.md
@@ -0,0 +1,15 @@
+---
+title: 'Preview Builds'
+---
+
+It is now possible using our deployment pipeline to run preview builds of Actual directly on Netlify.
+
+To do this, Find the pull request (pr) that you would like to preview in GitHub, you can find the pull requests in scope of the preview builds [here](https://github.com/actualbudget/actual/pulls).
+
+Once you have the number of the pr navigate to the following URL https://deploy-preview-{pr_number}--actualbudget.netlify.app/ replacing {pr_number} with the number of the pr you would like to preview, for example https://deploy-preview-414--actualbudget.netlify.app/
+
+This will load directly on Netlify where you will be able to preview the changes in that pull request without the need to clone the specific branch.
+
+:::info
+There is no sync server on preview builds so when asked "Where's the server" select "Don't use a server"
+:::
diff --git a/sidebars.js b/sidebars.js
index d444c88d83..d4ba37ddab 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -206,6 +206,7 @@ const sidebars = {
href: 'https://github.com/orgs/actualbudget/projects/1',
},
'Developers/project-layout',
+ 'Developers/preview-builds',
'Developers/releasing',
'Developers/Building-Windows',
'Developers/using-the-API',