Skip to content

Commit e1d3f62

Browse files
committed
commit initial claude changes to browser folder
1 parent 5f2001d commit e1d3f62

File tree

9 files changed

+264
-93
lines changed

9 files changed

+264
-93
lines changed

docs/browser/automatic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,4 +303,4 @@ What if I decide I don't want the automatic building feature?
303303
* [GitHub Directions to Disable and Enable a Workflow](https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow#disabling-a-workflow)
304304
* It is the Build action that kicks off the update and build steps, so simply disabling the one action is sufficient
305305

306-
* If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with [Configure to use Browser](bb-overview.md#configure-to-use-browser) to restore ability to build Loop with GitHub.
306+
* If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with [Configure to use Browser](bb-overview.md#step-by-step-build-process) to restore ability to build Loop with GitHub.

docs/browser/bb-overview.md

Lines changed: 88 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
## Build with a Browser
22

3-
* <span translate="no">Loop 3</span>&nbsp;can be built with a web browser using <span translate="no">GitHub Actions</span>
4-
* The app is then installed by you on your phone using the *TestFlight* app
5-
* If you prefer to use *Xcode* on your *Mac*, head over to [Build with *Mac*](../build/overview.md){: target="_blank" }
6-
* As long as you use the same *Apple Developer* account, the app you build is the same regardless of build method
3+
<span translate="no">Loop 3</span>&nbsp;can be built with a web browser using <span translate="no">GitHub Actions</span> and installed on your phone using the *TestFlight* app. This method works on any device with a browser (PC, Mac, tablet, or iPad) - no Mac computer required.
4+
5+
!!! success "Same App, Different Method"
6+
* If you prefer to use *Xcode* on your *Mac*, see [Build with *Mac*](../build/overview.md){: target="_blank" }
7+
* As long as you use the same *Apple Developer* account, the app you build is identical regardless of build method
78
* When you install the app on your phone, settings and history are preserved; pump and CGM remain attached; selected Services are maintained
89

10+
## Is This Method Right for You?
11+
12+
**Choose Browser Build if:**
13+
14+
* ✓ You don't have a Mac or prefer not to use one
15+
* ✓ You want automatic monthly builds (after initial setup)
16+
* ✓ You're comfortable following step-by-step instructions with multiple accounts (Apple, GitHub)
17+
* ✓ You can dedicate 2-4 hours for first-time setup (spread over several days)
18+
19+
**Choose Mac Build if:**
20+
21+
* You already have an up-to-date Mac and are comfortable with Xcode
22+
* You prefer building locally without cloud services
23+
* See [Build with Mac](../build/overview.md){: target="_blank" } for Mac requirements
24+
925
## Requirements
1026

1127
### Phone, CGM and Pump
@@ -24,23 +40,28 @@ To build the&nbsp;_<span translate="no">Loop</span>_&nbsp;app using a browser, y
2440
1. Free *GitHub* account: (instructions found at [New *GitHub* Account](secrets.md#new-github-account){: target="_blank" })
2541
1. Paid *Apple* Developer account: ($99/year; instructions found at [*Apple* Developer Account](../build/apple-developer.md){: target="_blank" })
2642

27-
## Instructions to Build with a Browser
43+
## Getting Started: Two Paths
2844

29-
### The Short Version
45+
Choose the path that matches your experience level:
3046

31-
Complete instructions are found at this link for those comfortable with using *GitHub* and navigating the *Apple Developer* and *Apple App Connect* pages.
47+
### 🟢 Path 1: Detailed Step-by-Step (Recommended for First-Time Builders)
3248

33-
* [Using GitHub Actions + FastLane to deploy to TestFlight](https://github.com/LoopKit/LoopWorkspace/blob/main/fastlane/testflight.md)
49+
Follow the detailed instructions below with screenshots, explanations, and help at every step.
3450

35-
### How-to Video to Build with a Browser
51+
**Start here:** [Introduction and Summary](intro-summary.md){: target="_blank" }
3652

37-
In addition to the pages linked below in [Configure to use Browser](#configure-to-use-browser), there is a narrated video of each step needed to build using a browser. (This video shows build steps for version 3.2.3 or older. Some items are simplified for version 3.4.1 and newer.)
53+
### 🔵 Path 2: Quick Reference (For Experienced Users)
3854

39-
* [How to Build the *Loop* App With a Web Browser](https://www.youtube.com/watch?v=kiu5ho0MTW8)
55+
If you're comfortable with GitHub and Apple Developer portals, use the condensed version:
4056

41-
### Configure to use Browser
57+
* **Documentation:** [Using GitHub Actions + FastLane to deploy to TestFlight](https://github.com/LoopKit/LoopWorkspace/blob/main/fastlane/testflight.md){: target="_blank" }
58+
* **Video Guide:** [How to Build Loop With a Web Browser](https://www.youtube.com/watch?v=kiu5ho0MTW8) (shows version 3.2.3; some steps simplified in 3.4.1+)
4259

43-
The steps on these pages must be completed for you to build an app using a browser:
60+
---
61+
62+
## Step-by-Step Build Process
63+
64+
The following pages guide you through the complete browser build process:
4465

4566
1. [Introduction and Summary](intro-summary.md){: target="_blank" }
4667
1. [Collect Secrets](secrets.md){: target="_blank" }
@@ -52,82 +73,83 @@ The steps on these pages must be completed for you to build an app using a brows
5273
1. [Prepare *TestFlight* Group](tf-users.md){: target="_blank" }
5374
1. [Build the *Loop* App](build-yml.md){: target="_blank" }
5475

55-
The pages of instructions listed above give detailed steps on how to build the *Loop* app. If you are building a different app, you can follow the detailed instructions but will need to know the Fork, App Name, Identifiers and in some cases App Group for the App you intend to build. Once you build one app, subsequent apps are much easier to build.
76+
---
77+
78+
## After Building: Next Steps
5679

57-
* [Build Other Apps with Browser](other-apps.md){: target="_blank" }
80+
Once your build completes successfully:
5881

59-
## Install on Phone
82+
1. **[Install on Phone](phone-install.md){: target="_blank" }** - Use TestFlight to install the app on your iPhone
83+
2. **[Update/Rebuild](bb-update.md){: target="_blank" }** - Learn how to update your app (much easier than initial build!)
84+
3. **[Build Other Apps](other-apps.md){: target="_blank" }** - Optional: Build LoopCaregiver, LoopFollow, or other apps using the same setup
6085

61-
Instructions to install on a phone are found at:
86+
---
6287

63-
* [Install on Phone](phone-install.md){: target="_blank" }
88+
## Need Help?
6489

65-
## What if I get stuck?
90+
!!! question "Stuck? Don't Get Frustrated!"
91+
First-time setup involves many steps across different websites. If something isn't working:
6692

67-
!!! important "How to Ask for Help"
68-
First time setup should take several hours, but if you are having trouble:
93+
**→ [Get Help from Mentors](bb-errors.md#help-with-errors){: target="_blank" }**
6994

70-
* [Click here to find help](bb-errors.md#help-with-errors){: target="_blank" }.
95+
Just provide your GitHub repository link and a brief description. Mentors can view your logs and guide you.
7196

72-
If you want to solve it yourself, try to:
97+
**Common troubleshooting resources:**
7398

74-
* Scroll back in the directions and see if you missed a paragraph or step
75-
* Be sure you are copying the exact **names** needed for each step or clicking on the **link** associated with a particular step - many pages look similar
76-
* Compare your display with the <span>graphics in *LoopDocs*</span>
77-
* Is something different or does yours have an error message?
78-
* Does the [Error](bb-errors.md){: target="_blank" } message guide you to the problem and solution?
79-
* Be aware that *GitHub* sometimes updates displayed names or locations for menu items - search for *GitHub* directions if your display looks different than our documentation
99+
* [Most Common Mistakes](bb-errors.md#most-common-mistakes){: target="_blank" }
100+
* [Complete Error Reference](bb-errors.md){: target="_blank" }
101+
* [How to Find Help](../intro/loopdocs-how-to.md#how-to-find-help)
80102

81-
## Errors while Configuring and Building
103+
!!! warning "Please DON'T..."
104+
* Search Google or ask ChatGPT about your error
105+
* Spend hours frustrated
106+
* Delete your repository or GitHub account
107+
* Remove your app from App Store Connect
82108

83-
If you get an error that you cannot figure out, reach out for help before you get frustrated or begin to delete things - let a mentor help you:
109+
**→ Ask a mentor instead!** They can quickly diagnose issues from your repository link.
84110

85-
* General instructions: [How to Find Help](../intro/loopdocs-how-to.md#how-to-find-help)
86-
* Browser Build instructions:
87-
* [Help with Errors](bb-errors.md#help-with-errors){: target="_blank" }
88-
* [Most Common Mistakes](bb-errors.md#most-common-mistakes){: target="_blank" }
89-
* With Browser Build, post your *GitHub* LoopWorkspace link and a brief description of your problem
111+
---
90112

91-
* [Errors with Browser](bb-errors.md){: target="_blank" }
113+
## Additional Topics
92114

93-
## Update the App
115+
### Automatic Updates
94116

95-
Instructions to make updates are found at:
117+
!!! success "Set It and Forget It"
118+
With Loop 3.4+, your app automatically rebuilds monthly (after initial setup). You just need to:
96119

97-
* [Update with Browser](bb-update.md){: target="_blank" }
120+
* Keep your Apple Developer account active
121+
* Install updates from TestFlight when ready
122+
* **Note:** Starting May 2025, you may need to [manually trigger builds](automatic.md#manual-action-for-automatic-build){: target="_blank" } every 60 days
98123

99-
There is also a helpful video for this process. Once again, this was prepared for an earlier version 3.2.3 or older. With version 3.4.1 and newer, the update and build is automatic if your *Apple* Developer account is active, agreements are signed and certificates are valid:
124+
Learn more: [Automatic Update & Build](automatic.md){: target="_blank" }
100125

101-
* [How to Update and Rebuild DIY Loop with a Web Browser](https://www.youtube.com/watch?v=0ipTsiqbbrQ)
126+
### Customization
102127

103-
> With `Loop 3.6.0`, certificates are automatically created and renewed. You no longer need to renew certificates as a separate step.
128+
Want to customize your Loop app? Both methods are supported:
104129

105-
## Other Topics
130+
* [Customize using Browser](custom-browser.md){: target="_blank" } - Configuration changes
131+
* [Custom Edits with Browser](edit-browser.md){: target="_blank" } - Code modifications
106132

107-
### Building the Development Version of the App
133+
### Development Version
108134

109-
For experienced and/or advanced users who want to build the development version of the app, there is additional information at the link below. If you have not built using the browser build method before, it is suggested you first build the released version. Once you have a successful build, then follow the steps for the development version. Building the app is independent of installing the app on your phone from *TestFlight*.
135+
For advanced users who want cutting-edge features before official release:
110136

111137
* [Build Development Version](build-dev-browser.md){: target="_blank" }
112138

113-
### Mac vs Browser
114-
115-
These considerations were prepared when most people were using a Mac computer to build the *Loop* app.
116-
117-
* *Mac* computer is not required to build or install the app
118-
* Anything with a browser works to build the *Loop* app: PC, Tablet, Mac or iPad
119-
* The *TestFlight* app is used to install the *Loop* app on your iPhone
120-
* Compatible version of *Xcode* is provided by *GitHub*
121-
* The time required for the initial setup to build with a browser may take less time than one *macOS* and *Xcode* version update for those using [Build with *Mac*](../build/overview.md){: target="_blank" }
122-
* Automatic Updates are loaded into *TestFlight*
123-
* With version 3.4 and newer, builds are automatically prepared at least once a month
124-
* You choose when to install the new app from TestFlight onto your phone
125-
* **WARNING:** starting May 2025, [Manual Action for Automatic Build](automatic.md#manual-action-for-automatic-build){: target="_blank" } may be required - be sure to check monthly to see if you need to start a build manually
126-
* Manual Updates are easy
127-
* Starting an update takes a few minutes of your time; it can be done from your phone; the rest is automatic and is done in about an hour
128-
* After the *GitHub* Build starts, your app is ready to install on your *iPhone* in about an hour
129-
* The app is delivered to your phone via *TestFlight*
130-
* The app is considered "Beta" by *Apple* and expires after 90 days
131-
* <span translate="no">Loop 3.4</span>&nbsp; and newer versions provide automatic build as the default
132-
* Customization methods are documented at [Customize with Browser](custom-browser.md){: target="_blank" }
139+
!!! tip "Build Stable First"
140+
We recommend building the stable release version first. Once successful, you can switch to the development version.
141+
142+
### Comparison: Browser vs Mac Build
143+
144+
| Feature | Browser Build | Mac Build |
145+
|---------|--------------|-----------|
146+
| **Computer Required** | Any device with browser | Mac with recent macOS |
147+
| **Xcode Required** | No (GitHub provides) | Yes (must update regularly) |
148+
| **Initial Setup Time** | 2-4 hours over several days | 1-2 hours (if Mac is ready) |
149+
| **Monthly Updates** | Automatic | Manual via Xcode |
150+
| **Build Time** | ~1 hour (in cloud) | ~30 minutes (local) |
151+
| **App Expiration** | 90 days (TestFlight) | 1 year |
152+
| **Customization** | Supported | Supported |
153+
154+
Both methods produce the identical Loop app. Choose based on your available hardware and preferences.
133155

docs/browser/build-yml.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
!!! abstract "Progress: Step 7 of 7"
2+
**📍 You are here:** Build the Loop App
3+
**⏱️ Time:** 20-30 minutes (mostly automated)
4+
**✅ Goal:** Trigger the build and wait for completion
5+
**📋 Next:** [Install on Phone](phone-install.md)
6+
17
## Build the *Loop* App
28

39
??? abstract "Section Summary (click to open/close)"
@@ -56,20 +62,31 @@ You can ignore an email from *Apple* that there are things you must fix in your
5662

5763
Did you get a red X? Head over to the [Errors with Browser](bb-errors.md){: target="_blank" } to page find a solution.
5864

65+
---
66+
5967
## Next Steps
6068

61-
It may take up to an hour for your new build to appear in TestFlight.
69+
!!! success "🎉 Congratulations!"
70+
Your Loop app is building! It will take about 20-30 minutes to complete.
71+
72+
**What happens now:**
73+
74+
1.**Wait ~30 minutes** - GitHub is building your app in the cloud
75+
2. 📧 **Check email** - You'll receive confirmation when build completes
76+
3.**Wait another ~30 minutes** - Apple processes the app for TestFlight
77+
4. 📧 **Second email** - TestFlight is ready!
6278

63-
From the phone where you want to install the *Loop* app, use TestFlight on that phone to install the app.
79+
**Next, install on your phone:**
6480

65-
* [Install on Phone](phone-install.md)
81+
** [Install on Phone](phone-install.md)**
6682

67-
If is you skipped the step about creating a *TestFlight* Group or want to add another person to your group:
83+
---
6884

69-
* [TestFlight Group](tf-users.md)
85+
**Additional Resources:**
7086

71-
## Caregivers
87+
* Need to add more people to TestFlight? [TestFlight Group](tf-users.md)
88+
* Building for a caregiver? [Build Other Apps with Browser](other-apps.md)
7289

73-
If you are a Caregiver who helps manage a loved-ones diabetes, you may use other open-source apps that can be built the same way:
90+
---
7491

75-
* When you are done building and installing the *Loop* app, there are instructions to [Build Other Apps with Browser](other-apps.md)
92+
**Navigation:** [← Back: TestFlight Group](tf-users.md) | [Next: Install on Phone →](phone-install.md)

docs/browser/identifiers.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
!!! abstract "Progress: Step 4 of 7"
2+
**📍 You are here:** Prepare Identifiers
3+
**⏱️ Time:** 15-30 minutes
4+
**✅ Goal:** Validate secrets and create Apple identifiers
5+
**📋 Next:** [Prepare App](prepare-app.md)
6+
17
## First Use of Actions Tab
28

39
Near the top middle of your <code>LoopWorkspace</code> &nbsp;<span class="notranslate">fork</span>&nbsp; is an <code>Actions</code> tab. This section provides detailed directions to enable <code>Actions</code>.
@@ -101,6 +107,14 @@ The `Add Identifiers` &nbsp;<span class=notranslate>Action</span>&nbsp; should s
101107
!!! important "Ask For Help Early"
102108
Please if you are having trouble - [ask for help early by clicking on this link](bb-errors.md#help-with-errors){: target="_blank" }.
103109

110+
---
111+
104112
## Next Step
105113

106-
The next step is to [Prepare the App](prepare-app.md).
114+
Identifiers created successfully! Now configure them at Apple:
115+
116+
**[Step 5: Prepare App](prepare-app.md)**
117+
118+
---
119+
120+
**Navigation:** [← Back: Prepare Fork](prepare-fork.md) | [Next: Prepare App →](prepare-app.md)

docs/browser/intro-summary.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
!!! abstract "Progress: Step 1 of 7"
2+
**📍 You are here:** Introduction and Summary
3+
**⏱️ Time:** 15-30 minutes to understand the process
4+
**📋 Next:** [Collect Secrets](secrets.md)
5+
16
## Summary of Steps
27

38
???+ info "Time Estimate (click to open/close)"
@@ -261,6 +266,14 @@ Some of these **terms** have ToolTips, so hover your mouse over those - or revie
261266
* Most Loopers will not have an App until using the <code>*GitHub* Browser Build</code>
262267
* The instructions walk you through creating and naming your app: [Create Loop App in App Store Connect](prepare-app.md#create-loop-app-in-app-store-connect){: target="_blank" }
263268
269+
---
270+
264271
## Next Step
265272
266-
The next step is to [Collect and Save Secrets](secrets.md).
273+
Ready to begin? Proceed to:
274+
275+
**→ [Step 2: Collect and Save Secrets](secrets.md)**
276+
277+
---
278+
279+
**Navigation:** [← Back to Overview](bb-overview.md) | [Next: Collect Secrets →](secrets.md)

0 commit comments

Comments
 (0)