From 666e79f9fa3e5cbdb9bafdc085fda96b2be6bbbc Mon Sep 17 00:00:00 2001 From: Bryan Oltman Date: Wed, 3 Jan 2024 14:00:47 -0500 Subject: [PATCH 1/3] Add overview page to explain code push at a high level --- docs/code_push/_category_.json | 2 +- docs/flutter-version.md | 2 +- docs/guides/_category_.json | 2 +- docs/overview.md | 25 +++++++++++++++++++++++++ docs/teams.md | 2 +- 5 files changed, 29 insertions(+), 4 deletions(-) create mode 100644 docs/overview.md diff --git a/docs/code_push/_category_.json b/docs/code_push/_category_.json index 782a82f7..a1a96608 100644 --- 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 index 885c8337..061c1ca8 100644 --- 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 index 1b5919aa..250707ec 100644 --- 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 new file mode 100644 index 00000000..eb706596 --- /dev/null +++ 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's Dart code instantly over the air, without going through the store update process. This allows you to deploy fixes and new features to your end users. + +## 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 index 894feb2b..f4320b43 100644 --- 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 --- From e952ab1952802ab6044b1776ca4f80ba5778ef6b Mon Sep 17 00:00:00 2001 From: Bryan Oltman Date: Wed, 3 Jan 2024 14:03:06 -0500 Subject: [PATCH 2/3] reword --- docs/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview.md b/docs/overview.md index eb706596..c3b23391 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -8,7 +8,7 @@ description: A high-level explanation of what Code Push is and how it works. ## What is Code Push? -Code Push is a tool that allows you to update your Flutter app's Dart code instantly over the air, without going through the store update process. This allows you to deploy fixes and new features to your end users. +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 deploy fixes and new features to your end users. ## How does Code Push work? From 06aaeb7c47972b9175c3e31f3454f3dc987d2e2e Mon Sep 17 00:00:00 2001 From: Bryan Oltman Date: Wed, 3 Jan 2024 14:12:32 -0500 Subject: [PATCH 3/3] Update docs/overview.md Co-authored-by: Felix Angelov --- docs/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview.md b/docs/overview.md index c3b23391..0f7b86c5 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -8,7 +8,7 @@ description: A high-level explanation of what Code Push is and how it works. ## 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 deploy fixes and new features to your end users. +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?