Merge pull request #609 from marionbarker/working-docs

Updates for Loop 3.2.1

Author: marionbarker

docs/build/code_customization.md

@@ -1,5 +1,10 @@
 ## Code Customizations
 
+!!! danger "Version 3.2.1"
+    With the release of Loop 3.2.1, the location for the Eros pod customizations has moved.
+
+    LoopDocs will be updated later. The Key_Phrase search should still work for Mac/Xcode folks.
+
 ### Mac/Xcode
 
 The customization instructions on this page were written for the [Mac-Xcode Build](../build/overview.md) method.

docs/build/step14.md

@@ -310,7 +310,8 @@ First select Loop (Workspace) and confirm your phone is selected. Refer to the G
 * Frame 1:  Xcode screen opened by the script after a fresh download
     * **Fresh Download? Wait for indexing to begin**
         * If you see messages about fetching symbols or resolving packages, please wait until you see the Indexing message as shown in the GIF below just to the left of the dashed-blue rectangle
-    * **Loop 3.2.0** not longer requires you to select Loop (Workspace) - it is now the default
+    * **With Loop 3.2.x and newer**, you do not need to select Loop (Workspace) - it is now the default and shows up as LoopWorkspace
+        * The graphics still show the old selection process
     * The red rectangle indicates where you will change Loop to Loop (Workspace)
     * The red x in the dashed-blue rectangle region indicates you need to fix a problem before building
 * Frame 2: Inset shows the action needed to select Loop (Workspace)

docs/build/step8.md

@@ -79,11 +79,15 @@ The list below contains the **minimum** versions of [macOS](step1.md#check-your-
 
 **Newer versions of Xcode are always OK and should be used if your computer will accept the upgrade. Xcode 14.1 is listed instead of 14.0 because that version had a lot of bugs in it.**
 
-**With the release of Loop 3.0.0 and Loop 3.2.0, this list is pretty simple.**
+**With the release of Loop 3, this list is pretty simple.**
 
+* Xcode 14.2 or higher is required for
+    * iOS 16.2 and newer
 * Xcode 14.1 or higher is required
     * iOS 15.1 is minimum version for phone but 15.7.1 is better (for older phones)
-    * iOS 16.x is supported (turn on developer mode when using Mac-Xcode build)
+    * iOS 16.0 through 16.1.x is supported
+
+When using a Mac/Xcode build and an iOS 16 device, you must turn on developer mode for both the phone, and if paired, the watch.
 
 This older list is left in for those still using code based off Loop 2.2.x
 

docs/faqs/glossary.md

@@ -91,6 +91,8 @@ If you hover your mouse or tap on a mobile device, the phrase associated with ea
 
 **Glucose Safety Limit**: Loop will not suggest insulin delivery when glucose prediction (in next 3 hours) goes below this limit; in Loop 2 this was called Suspend Threshold
 
+**GMT**: Greenwich Mean Time is mean (average) solar time at 0 degrees longitude, see UTC
+
 **Guardrails**: limits in the code for user selected settings, recommended and absolute limits are provided
 
 **Hamburger Menu**: three parallel lines that, when tapped, open a new menu
@@ -109,6 +111,8 @@ If you hover your mouse or tap on a mobile device, the phrase associated with ea
 
 **Issue**: On github - a formal method to report a problem, either code behavior or documentation
 
+**JSON**: JavaScript Object Notation; a standard data interchange format that is text-based and human readable
+
 **macOS**: operating system for Mac computer
 
 **Lock your Phone**: click the button on the side of the phone to lock it - prevent accidental touch, i.e., accidental Loop command
@@ -189,6 +193,8 @@ If you hover your mouse or tap on a mobile device, the phrase associated with ea
 
 **URL**: website address (Uniform Resource Locator)
 
+**UTC**: Coordinated Universal Time is a time standard for civil time and time zones worldwide
+
 **Ventura**: operating system for Mac, macOS 13.x
 
 **watchOS**: Apple watch operating system; must be compatible with phone iOS

docs/gh-actions/gh-customize.md

@@ -3,8 +3,13 @@
 !!! danger "DRAFT"
     This procedure is in DRAFT mode - only minimal graphics are provided.
 
+    The entire procedure may change without warning, so be prepared for updates.
+
     WARNING - After a recent release - wait for the release number to be updated on this page before using any of the copy/paste commands.
 
+    This page has not been updated for Loop 3.2.1.
+    Please be patient - the location for customization for Eros pods has changed and will be updated on this page and [Code Customization](../build/code_customization.md) page - but later.
+
 !!! info "Time Estimate"
     * About half an hour to an hour per Module
         * Typically 1 or 2 Modules
@@ -160,7 +165,7 @@ After these two steps are completed, then you will continue to [Customize the Mo
     * After you paste the Prepare xxx Module command (below), STOP if you get an error
     * If you do not get an error, continue to [Create New Branch](#create-new-branch) which is the same for all modules.
 
-Copy the selected line for the current module into the terminal. If you see an error STOP. 
+Copy the selected line for the current module into the terminal. If you see an error STOP.
 
 * Did you copy the correct line for the current Module?
 * Is your Module dev branch up to date?

docs/gh-actions/gh-first-time.md

@@ -539,11 +539,11 @@ Once all six secrets have been added to your LoopWorkspace, you are done with Se
 !!! tip "Time for a Break?"
     This is a good place to pause if you need to. Just note where you are on the page so you can return later.
 
-## Verify Secrets
+## Validate Secrets
 
-This step, new with Loop 3.2.0 checks that the Secrets you added are correct. Some things cannot be verified yet, but most can and a relatively clear error message is provided.
+This step, new with Loop 3.2.x checks that the Secrets you added are correct. Some things cannot be validated at this point, but most can and a relatively clear error message is provided.
 
-This will be updated soon, but for now - follow the instructions under Add Identifiers for Loop, but do the first action: 1 Verify Secrets.
+This will be updated soon, but for now - follow the instructions under Add Identifiers for Loop, but do the first action: 1 Validate Secrets.
 
 ## Add Identifiers for Loop
 

docs/gh-actions/gh-update.md

@@ -142,15 +142,16 @@ Scroll all the way to the top of the screen and tap on your LoopWorkspace link.
 
 1. Sign in to GitHub and select your LoopWorkspace repository from your repositories list
 1. Look to see if your fork is up to date
-    * The dropdown in this graphic shows the dev branch.
-    * To build Loop 3.2, you will want main
-    * If you previously build Loop 3.0 with this method - don't forget to update your branch
-    * If your fork is up to date with LoopKit version for that `{branch}`, you will see the message `This branch is up to date with LoopKit/LoopWorkspace:{branch}}` - there is no need to build again unless you are near your 90 day expiration data - in which case, proceed to Step 3
-    * If your fork shows a message such as `This branch is 3 commits behind LoopKit:dev` and you want to update and build, then click `Sync Fork` by tapping where the red rectangle is shown in the graphic below, then in the pop-up window, tap on `Update branch`
+    * When you go to your fork to do the update, simply sync the branch if it says there are updates and you get the latest release (details below graphic)
+        * The dropdown in this graphic shows the dev branch (graphic to be updated later)
+        * Yours should show the main branch
 
     ![message displayed when your fork of LoopWorkspace is behind LoopKit version](img/github-build-check-fork-status.svg){width="700"}
     {align="center"}
 
+    * If your fork is up to date with LoopKit version for that `{branch}`, you will see the message `This branch is up to date with LoopKit/LoopWorkspace:{branch}}` - there is no need to build again unless you are near your 90 day expiration data - in which case, proceed to Step 3
+    * If your fork shows a message such as `This branch is 3 commits behind LoopKit:main` and you want to update and build, then click `Sync Fork` by tapping where the red rectangle is shown in the graphic below, then in the pop-up window, tap on `Update branch`
+
 1. Build Loop - refer to graphic below as you follow the steps
     * Click on the 'Actions' tab
     * Select the 'Build Loop' workflow on the left
@@ -168,6 +169,8 @@ Scroll all the way to the top of the screen and tap on your LoopWorkspace link.
         * Click on the most recent Build job with the red x by it
         * If the details show this message, "[Could not install WWDR certificate](gh-errors.md#could-not-install-wwdr-certificate)", make sure your developer account is in good standing and that there are no agreements that need to be accepted
         * Repeat the build (previous step) and it should be fine the next time
+    * If you get an email from Apple that there are things you must fix in your app - that refers to things to fix before putting that app in the App Store and you will not be doing that
+        * As long as you get the TestFlight updated app, you can ignore that email
 1. The updated Loop app will show up in your TestFlight app
     * But wait until you see "Expires in 90 days"
     * The app is in TestFlight from your prior build
@@ -181,6 +184,8 @@ Scroll all the way to the top of the screen and tap on your LoopWorkspace link.
     ![install Loop from TestFlight](img/testflight-install-loop.gif){width="300"}
     {align="center"}
 
+1. If you are building for a child, follow the [Install TestFlight Loop for Child](gh-deploy.md#install-testflight-loop-for-child) instructions again
+
 ## GitHub Build Details
 
 In the Loop app, once installed on your phone, tap on Settings -> Support -> Issue Report. The graphic below shows an example of the Build Details included in the report.

docs/intro/loopdocs-how-to.md

@@ -8,11 +8,11 @@ Every tooltip definition is also found in the [Glossary](../faqs/glossary.md) -
 
 Volunteers generously provide support for Loop via online platforms. You have a number of options for joining conversations on loop and asking for help.  Links to the main platforms are listed below.  Non-US Loop users in Italy, Australia, and several other countries have also formed Facebook (FB) groups.
 
-  * The [Looped Group](https://www.facebook.com/groups/TheLoopedGroup) on Facebook. Looped Group is the original FB group for DIY looping systems. There are lot of active members there with an excellent history of helping people.
-  * Loop and Learn is a community that provides Loop-centric information, a T1D Speaker Series covering many topics of general diabetes interest as well as Loop-specific chats, alerts whenever there is an update to iOS and Xcode, Quick Tips and articles written by mentors providing their Loop experience.
-      * [LoopandLearn Facebook Group](https://www.facebook.com/groups/LOOPandLEARN)
-      * [LoopandLearn Website](https://www.loopandlearn.org)
-      * [LoopandLearn YouTube Channel](https://youtube.com/loopandlearn)
+* The [Looped Group](https://www.facebook.com/groups/TheLoopedGroup) on Facebook. Looped Group is the original FB group for DIY looping systems. There are lot of active members there with an excellent history of helping people.
+* Loop and Learn is a community that provides Loop-centric information, a T1D Speaker Series covering many topics of general diabetes interest as well as Loop-specific chats, alerts whenever there is an update to iOS and Xcode, Quick Tips and articles written by mentors providing their Loop experience.
+    * [LoopandLearn Facebook Group](https://www.facebook.com/groups/LOOPandLEARN)
+    * [LoopandLearn Website](https://www.loopandlearn.org)
+    * [LoopandLearn YouTube Channel](https://youtube.com/loopandlearn)
 * The [LoopTips](https://loopkit.github.io/looptips/) website provides non-build information that is helpful once you are looping, e.g., how to print endo reports, find Loop data, deal with therapy settings changes, etc.
 * Many Loopers use a companion app called Nightscout. Nightscout help can be found in the [CGM in the Cloud](https://www.facebook.com/groups/CGMinthecloud) Facebook group.
 * For those interested in what is coming next for Loop and those who prefer not to use Facebook, join [Loop Zulipchat](https://loop.zulipchat.com) and be sure to subscribe to all the streams or you'll miss some interesting conversations.