Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/code_push/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "☁️ Code Push",
"position": 2,
"position": 3,
"link": {
"title": "Code Push",
"slug": "code-push",
Expand Down
2 changes: 1 addition & 1 deletion docs/flutter-version.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
title: 🐦 Flutter Version
description: How to manage your Shorebird Flutter version
---
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "🗺️ Guides",
"position": 3,
"position": 4,
"link": {
"title": "Guides",
"slug": "guides",
Expand Down
25 changes: 25 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -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 deploy fixes and new features to your end users.
bryanoltman marked this conversation as resolved.
Show resolved Hide resolved

## 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.
2 changes: 1 addition & 1 deletion docs/teams.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 6
title: 👥 Teams
description: Working with a team of developers
---
Expand Down