Add overview page to explain code push at a high level (#173)

* Add overview page to explain code push at a high level * reword * Update docs/overview.md Co-authored-by: Felix Angelov <[email protected]> --------- Co-authored-by: Felix Angelov <[email protected]>
shorebirdtech · Jan 3, 2024 · 672927c · 672927c
1 parent aaba837
commit 672927c
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 4 deletions.
diff --git a/docs/code_push/_category_.json b/docs/code_push/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "☁️ Code Push",
-  "position": 2,
+  "position": 3,
   "link": {
     "title": "Code Push",
     "slug": "code-push",

diff --git a/docs/flutter-version.md b/docs/flutter-version.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 title: 🐦 Flutter Version
 description: How to manage your Shorebird Flutter version
 ---

diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "🗺️ Guides",
-  "position": 3,
+  "position": 4,
   "link": {
     "title": "Guides",
     "slug": "guides",

diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 2
+title: 🌎 Overview
+description: A high-level explanation of what Code Push is and how it works.
+---
+
+# Overview
+
+## What is Code Push?
+
+Code Push is a tool that allows you to update your Flutter app instantly over the air, without going through the store update process. This allows you to directly deploy fixes and new features to your end users' devices.
+
+## How does Code Push work?
+
+Apps built with Shorebird include a modified Flutter engine, which checks for updates to your app's Dart code on startup. If an update is available, the engine downloads the update. The user will see the update on the next app restart after the update is downloaded.
+
+A typical Code Push workflow looks like this:
+
+1. Use the Shorebird CLI to create a new **release** of your app.
+1. Distribute that release through the App Store or Google Play.
+1. Make changes to your app's Dart code. This could be a bug fix, a new feature, or anything else, and is not limited to your app's UI – this can include updated dependencies as well.
+1. Use the Shorebird CLI to create a new **patch** to the release you created in the first step.
+1. That's it! Your users will see the update the next time they restart your app.
+
+A more detailed walkthrough of this process is available in the [Getting Started](/) guide. The [Concepts](concepts) section contains more information about the terminology used in this guide.
diff --git a/docs/teams.md b/docs/teams.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 6
 title: 👥 Teams
 description: Working with a team of developers
 ---