Skip to content

Commit 3bbf5ba

Browse files
authored
feat: update navigation (#350)
* feat: update navigation * spelling fixes * another spelling fix * fixing broken internal links * setup and install -> quickstart * better name * fixing bad links
1 parent f0bc903 commit 3bbf5ba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1285
-841
lines changed

.github/cspell.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
"boltman",
2626
"bryanoltman",
2727
"buildroot",
28-
"Classpath",
28+
"canva",
29+
"classpath",
2930
"codemagic",
3031
"codepush",
3132
"codesign",
@@ -41,7 +42,7 @@
4142
"prefs",
4243
"previewable",
4344
"rollouts",
44-
"SDKMAN",
45+
"sdkman",
4546
"shorebirdtech",
4647
"temurin",
4748
"xcarchive",

astro.config.mjs

Lines changed: 14 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -52,110 +52,33 @@ export default defineConfig({
5252
},
5353
sidebar: [
5454
{
55-
label: 'Getting Started',
55+
label: 'Welcome',
5656
link: '/',
5757
},
5858
{
59-
label: 'Code Push',
60-
autogenerate: {
61-
directory: 'code-push',
62-
},
63-
},
64-
{
65-
label: 'Guides',
66-
items: [
67-
{
68-
label: 'Development Workflow',
69-
link: '/guides/development-workflow',
70-
},
71-
{
72-
label: 'Staging Patches',
73-
link: '/guides/staging-patches',
74-
},
75-
{
76-
label: 'Testing Patches',
77-
link: '/guides/testing-patches',
78-
},
79-
{
80-
label: 'Signing Patches',
81-
link: '/guides/patch-signing',
82-
},
83-
{
84-
label: 'Percentage-Based Rollouts',
85-
link: '/guides/percentage-based-rollouts',
86-
},
87-
{
88-
label: 'Crash Reporting',
89-
link: '/guides/crash-reporting',
90-
},
91-
{
92-
label: 'Flavors',
93-
autogenerate: {
94-
directory: 'guides/flavors',
95-
},
96-
},
97-
{
98-
label: 'Submitting to Stores',
99-
autogenerate: {
100-
directory: 'guides/submitting',
101-
},
102-
},
103-
{
104-
label: 'Hybrid Apps',
105-
autogenerate: {
106-
directory: 'guides/hybrid-apps',
107-
},
108-
},
109-
],
110-
},
111-
{
112-
label: 'Continuous Integration',
113-
autogenerate: {
114-
directory: 'ci',
115-
},
116-
},
117-
{
118-
label: 'Crash Reporting',
119-
autogenerate: {
120-
directory: 'guides/crash-reporting',
121-
},
59+
label: 'Getting Started',
60+
collapsed: true,
61+
autogenerate: { directory: 'Getting Started' },
12262
},
12363
{
124-
label: 'Flutter Version',
125-
link: '/flutter-version',
64+
label: 'Code Push',
65+
collapsed: true,
66+
autogenerate: { directory: 'Code Push' },
12667
},
12768
{
128-
label: 'Organizations',
129-
link: '/orgs',
69+
label: 'Shorebird Account',
70+
collapsed: true,
71+
autogenerate: { directory: 'Shorebird Account' },
13072
},
13173
{
132-
label: 'Update Strategies',
133-
link: '/update-strategies',
74+
label: 'Shorebird System',
75+
collapsed: true,
76+
autogenerate: { directory: 'Shorebird System' },
13477
},
13578
{
136-
label: 'FAQ',
79+
label: 'FAQ & Troubleshooting',
13780
link: '/faq',
13881
},
139-
{
140-
label: 'Status',
141-
link: '/status',
142-
},
143-
{
144-
label: 'Billing',
145-
link: '/billing',
146-
},
147-
{
148-
label: 'Architecture',
149-
link: '/architecture',
150-
},
151-
{
152-
label: 'Uninstall',
153-
link: '/uninstall',
154-
},
155-
{
156-
label: 'Troubleshooting',
157-
link: '/troubleshooting',
158-
},
15982
],
16083
plugins: [
16184
starlightLinksValidator({

src/content/docs/ci/_authentication.mdx renamed to src/content/docs/Code Push/Continuous Integration/_authentication.mdx

File renamed without changes.

src/content/docs/ci/codemagic.mdx renamed to src/content/docs/Code Push/Continuous Integration/codemagic.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Codemagic Integration
33
description: Integrate Shorebird into your Codemagic workflow
44
sidebar:
55
label: Codemagic
6-
order: 2
6+
order: 9
77
---
88

99
{/* cspell:words Codemagic astrojs proto tlsv maclinux elif getenv codesigning testflight */}

src/content/docs/ci/fastlane.mdx renamed to src/content/docs/Code Push/Continuous Integration/fastlane.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Fastlane
33
description: Using fastlane with Shorebird
4+
sidebar:
5+
order: 10
46
---
57

68
{/* cspell:words Fastfile testflight */}
@@ -19,7 +21,8 @@ Follow the setup instructions on the fastlane website to install fastlane
1921

2022
This guide assumes that you have shorebird installed on the machine that will be
2123
running the fastlane commands. If you have not already installed shorebird, you
22-
can do so by following the [Getting Started instructions](/#install).
24+
can do so by following the
25+
[Getting Started instructions](/getting-started/quick-start).
2326

2427
If you are not already using fastlane with your project, navigate to your app's
2528
`ios` directory in your project and run `fastlane init`. You will be prompted to
@@ -52,10 +55,15 @@ To run this, execute the following command:
5255
bundle exec fastlane release_shorebird
5356
```
5457

55-
:::note To upload to TestFlight, you will need to create an Apple app-specific
56-
password. You can do this at https://appleid.apple.com/account/manage. Once you
57-
have created the password, create a `.env` file in your fastlane directory and
58-
add `FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD=your_password_here`. :::
58+
{/* prettier-ignore */}
59+
:::note
60+
61+
To upload to TestFlight, you will need to create an Apple app-specific password.
62+
You can do this at https://appleid.apple.com/account/manage. Once you have
63+
created the password, create a `.env` file in your fastlane directory and add
64+
`FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD=your_password_here`.
65+
66+
:::
5967

6068
If you would like to provide additional arguments to the release command, you
6169
can do so using the `args` parameter. For example:

src/content/docs/ci/generic.mdx renamed to src/content/docs/Code Push/Continuous Integration/generic.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: CI Integration
33
description: Integrate Shorebird in CI
44
sidebar:
55
label: Generic
6-
order: 3
6+
order: 11
77
---
88

99
{/* cspell:words proto tlsv codemagic */}
@@ -18,8 +18,8 @@ Flutter CI builds. Changes required:
1818

1919
We have detailed instructions for integrating into
2020

21-
- [GitHub](/ci/github)
22-
- [Codemagic](/ci/codemagic)
21+
- [GitHub](/code-push/continuous-integration/github)
22+
- [Codemagic](/code-push/continuous-integration/codemagic)
2323

2424
However if you do not use these providers, we've also provided generic
2525
instructions below:

src/content/docs/ci/github.mdx renamed to src/content/docs/Code Push/Continuous Integration/github.mdx

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: GitHub Integration
33
description: Integrate Shorebird into your GitHub workflow
44
sidebar:
55
label: GitHub
6-
order: 1
6+
order: 8
77
---
88

99
{/* cspell:words shorebirdtech */}
@@ -19,7 +19,12 @@ Action allows you to integrate Shorebird into your existing GitHub Workflows.
1919

2020
✅ You are logged into a Shorebird account.
2121

22-
:::note Refer to the [getting started](/) instructions for more information. :::
22+
{/* prettier-ignore */}
23+
:::note
24+
25+
Refer to the [getting started](/) instructions for more information.
26+
27+
:::
2328

2429
## Quick Start
2530

@@ -56,8 +61,13 @@ In the above workflow, we're using the `setup-shorebird` action to configure
5661
Shorebird in our CI and in subsequent steps we can execute any Shorebird
5762
commands.
5863

59-
:::note Currently `setup-shorebird` only supports the latest stable version of
60-
shorebird. :::
64+
{/* prettier-ignore */}
65+
:::note
66+
67+
Currently `setup-shorebird` only supports the latest stable version of
68+
shorebird.
69+
70+
:::
6171

6272
## Authentication
6373

@@ -197,4 +207,4 @@ jobs:
197207
:::
198208

199209
For an example of a fully automated development workflow, see our
200-
[Development Workflow Guide](/guides/development-workflow).
210+
[Development Workflow Guide](/code-push/guides/development-workflow).

src/content/docs/guides/crash-reporting/Integrations/crashlytics.mdx renamed to src/content/docs/Code Push/Crash Reporting/crashlytics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Crashlytics Integration
33
description: Integrate Shorebird into your Crashlytics crash reporting
44
sidebar:
55
label: Crashlytics
6-
order: 2
6+
order: 14
77
---
88

99
If you're using Crashlytics for crash reporting, it will work out-of-the-box

src/content/docs/guides/crash-reporting/Integrations/sentry.mdx renamed to src/content/docs/Code Push/Crash Reporting/sentry.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Sentry Integration
33
description: Integrate Shorebird into your Sentry crash reporting
44
sidebar:
55
label: Sentry
6-
order: 1
6+
order: 13
77
---
88

99
If you're using Sentry for crash reporting, it will work out-of-the-box with

src/content/docs/guides/crash-reporting/uploading-symbols.mdx renamed to src/content/docs/Code Push/Crash Reporting/uploading-symbols.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Uploading Symbols
33
description: Locating and uploading symbols for crash reporting
4+
sidebar:
5+
order: 12
46
---
57

68
Shorebird uses a fork of Flutter to build your app. This means we've built our

0 commit comments

Comments
 (0)