Skip to content

Commit

Permalink
docs: move overview section into code push group (#304)
Browse files Browse the repository at this point in the history
  • Loading branch information
felangel authored Oct 11, 2024
1 parent ea948ee commit e0681a4
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 33 deletions.
47 changes: 22 additions & 25 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ export default defineConfig({
label: 'Getting Started',
link: '/',
},
{
label: 'Overview',
link: '/overview',
},
{
label: 'Code Push',
autogenerate: {
Expand Down Expand Up @@ -163,26 +159,27 @@ export default defineConfig({
},
redirects: {
// Redirects to preserve legacy URLs.
ci: '/ci/github',
'code_push/initialize': 'code-push/initialize/',
'code_push/patch': 'code-push/patch/',
'code_push/preview': 'code-push/preview/',
'code_push/release': 'code-push/release/',
'code_push/run': 'code-push/preview',
guides: '/',
'guides/add-to-app/ios': 'guides/hybrid-apps/ios',
'guides/code_push_add_to_app': 'guides/hybrid-apps/android',
'guides/code_push_quickstart': 'guides/code-push-quickstart',
'guides/crash-reporting': 'guides/crash-reporting/uploading-symbols',
'guides/fastlane': 'ci/fastlane',
'guides/flavors': 'guides/flavors/android',
'guides/code-push-quickstart': '/',
'guides/hybrid-app': 'guides/hybrid-apps/android',
'guides/hybrid-app/android': 'guides/hybrid-apps/android',
'guides/hybrid-app/ios': 'guides/hybrid-apps/ios',
'guides/release/android': 'guides/submitting/play-store',
'guides/release/ios': 'guides/submitting/app-store',
concepts: 'overview',
teams: 'orgs',
'/ci': '/ci/github',
'/code_push/initialize': 'code-push/initialize/',
'/code_push/patch': 'code-push/patch/',
'/code_push/preview': 'code-push/preview/',
'/code_push/release': 'code-push/release/',
'/code_push/run': 'code-push/preview',
'/concepts': '/code-push/overview',
'/guides': '/',
'/guides/add-to-app/ios': 'guides/hybrid-apps/ios',
'/guides/code_push_add_to_app': 'guides/hybrid-apps/android',
'/guides/code_push_quickstart': 'guides/code-push-quickstart',
'/guides/crash-reporting': 'guides/crash-reporting/uploading-symbols',
'/guides/fastlane': 'ci/fastlane',
'/guides/flavors': 'guides/flavors/android',
'/guides/code-push-quickstart': '/',
'/guides/hybrid-app': 'guides/hybrid-apps/android',
'/guides/hybrid-app/android': 'guides/hybrid-apps/android',
'/guides/hybrid-app/ios': 'guides/hybrid-apps/ios',
'/guides/release/android': 'guides/submitting/play-store',
'/guides/release/ios': 'guides/submitting/app-store',
'/overview': '/code-push/overview',
'/teams': 'orgs',
},
});
2 changes: 1 addition & 1 deletion src/content/docs/code-push/initialize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Initialize Shorebird
description: Learn how to add code push to an existing Flutter project.
sidebar:
label: Initialize
order: 1
order: 2
---

To configure an existing Flutter project to use Shorebird, use `shorebird init`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Overview
description: A high-level explanation of what Code Push is and how it works.
sidebar:
label: Overview
order: 1
---

## What is Code Push?
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/code-push/patch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create a Patch
description: Learn how to push updates to an app with Shorebird.
sidebar:
label: Patch
order: 4
order: 5
---

import { Tabs, TabItem } from '@astrojs/starlight/components';
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/code-push/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Preview Locally
description: Learn how to preview an existing release of your application.
sidebar:
label: Preview
order: 3
order: 4
---

Once you have [created a release](/code-push/release), you can preview your
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/code-push/release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create a Release
description: Learn how to publish a new app release to Shorebird.
sidebar:
label: Release
order: 2
order: 3
---

import { Tabs, TabItem } from '@astrojs/starlight/components';
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/code-push/rollback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Roll back a Patch
description: Learn how to roll back a patch in Shorebird.
sidebar:
label: Rollback
order: 5
order: 6
---

If you discover that a live patch has a bug, Shorebird supports patch roll back.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ update it to new code. The `shorebird patch` command is used to generate
a patch from your new local code which is then diffed with the release binary
to generate a patch which is then shipped to your users.

We explain more of these terms in [Overview](/overview).
We explain more of these terms in [Overview](/code-push/overview).

### Can I use Shorebird in my country?

Expand Down Expand Up @@ -197,7 +197,7 @@ for you, please let us know!

Yes. There is no limit on the size of the application that can be patched with
code push. As noted in
[Overview](/overview#what-types-of-changes-can-be-included-in-a-patch),
[Overview](/code-push/overview#what-types-of-changes-can-be-included-in-a-patch),
Shorebird can change any Dart code in your application no matter of size.

### What can I use Shorebird code push for?
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/update-strategies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ necessary patch and _not_ then prompt them to update.
Shorebird patches are typically much smaller than full app downloads (a few KB
on Android, a few hundred KB on iOS), so it is likely better for your users if
you can use Shorebird to deliver patches instead of `in_app_update`. However,
there are [changes which Shorebird cannot make](/overview#what-types-of-changes-can-be-included-in-a-patch), so
there are [changes which Shorebird cannot make](/code-push/overview#what-types-of-changes-can-be-included-in-a-patch), so
`in_app_update` may be the best solution in some cases.

Shorebird "patches" also do not change the version number of your app, so
Expand Down

0 comments on commit e0681a4

Please sign in to comment.