Merge pull request #904 from marionbarker/working-docs

Update before Loop 3.6.0 release

Author: marionbarker

docs/browser/automatic.md

@@ -41,7 +41,7 @@ You start getting [Notifications](../operation/features/notifications.md#loop-ap
 
 The automatic update and build feature is embedded in the build_loop.yml code and uses the GitHub scheduling feature to trigger actions to run automatically.
 
-Some may have noticed one or more branches added to your repository that start with the name `alive`. Don't worry about these. They are automatically created to ensure GitHub will keep building your app automatically.
+One or more branches are added to your repository that start with the name `alive`. Don't worry about these. They are automatically created so GitHub will keep building your app automatically.
 
 * GitHub keeps track of repositories
 * If there is no activity in a given repository in 60 days, GitHub disables Actions
@@ -50,7 +50,7 @@ Some may have noticed one or more branches added to your repository that start w
 
 You may see branches called `alive`, `alive-dev` or `alive-main` in your repository.
 
-The `alive` branches are created and used to make sure at least one commit per month is added to an `alive` branch in your repository. That keeps your repository active to allow the automatic update and build process to work.
+The `alive` branches are there so at least one commit per month is added to an `alive` branch in your repository. That keeps your repository active to allow the automatic update and build process.
 
 The `alive` branches are only used for the keep-alive functions. Do not build using an `alive` branch. Most people will build using the default branch of `main`.
 
@@ -69,57 +69,49 @@ The `alive` branch you need is created automatically when you run the `Build Loo
 
 Coming soon with `Loop 3.6.0`. 
 
-Already here with `LoopFollow 2.3.0` and some other Open-Source apps.
+Already here with `LoopCaregiver`, `LoopFollow` and some other Open-Source apps.
 
 ### Requirements
 
 You must have the `ENABLE_NUKE_CERTS` variable set to `true` for your *GitHub* organization, or when using a personal account to build, add it to each repository.
 
 * Refer to [Add Variable](prepare-fork.md#add-variable){: target="_blank" }
 
-### Certificates and `Match-Secrets`
+??? question "Do you want to know more? (Click to open/close)"
+    **Annual Renewal**
 
-The Create Certificates action does the following:
+    Once a year, *Apple* automatically expires your `Distribution` Certificate.
 
-* Reads existing signing credentials from your `Match-Secrets` private respository and confirms if they are valid
-* OR
-* Uses your `Distribution` Certificate from *Apple* or creates a new one if one does not exist
-* Securely stores, in  your `Match-Secrets` private repository, signing credentials (like certificates and provisioning profiles from *Apple*) used for code signing for each Identifier in your app when you build
+    * When the *Apple* `Distribution` certificate expires, the saved credentials in your `Match-Secrets` private repository are invalid and need to be removed (<code>nuke</code>)
+    * You need a new `Distribution` Certificate at *Apple*
+    * You need to create new signing credentials for `Match-Secrets`
 
-### Annual Renewal
-
-This happens once a year after *Apple* automatically expires your `Distribution` Certificate.
-
-* When the *Apple* `Distribution` certificate expires, the saved credentials in your `Match-Secrets` private repository are invalid and need to be removed (<code>nuke</code>)
-* You need a new `Distribution` Certificate at *Apple*
-* You need to create new signing credentials for `Match-Secrets`
-
-For the `Loop` app, up through version 3.4.4, you need to do this process manually.
+    For the `Loop` app, up through version 3.4.4, you must to do this [Renew Certificate](bb-update.md#renew-certificate){: target="_blank" } process manually. Once version 3.6.0 is released, it will be automatic.
 
 ### Automatic Certificate Renewal
 
-Some Open-Source apps, in particular `Trio` and `LoopFollow 2.3.0` already have this capability.
+Some Open-Source apps, in particular `Trio`, `LoopCaregiver` and `LoopFollow` already have this capability. It will be available in with the next release of the *Loop* app (3.6.0).
 
 * If your signing credentials for the app being built are invalid and `ENABLE_NUKE_CERTS` is `true`, then signing credentials will be cleared from your `Match-Secrets` repository, a new `Distribution` certificate will be created at *Apple* and signing credentials for the current app will be generated and stored in `Match-Secrets`.
 
-* Next app you build will need certificates created because all signing credentials were cleared out of your `Match-Secrets` repository
+* The next app you build using Browser Build, following a `nuke` action, will need certificates created because all signing credentials were cleared out of your `Match-Secrets` repository
     * If that app is configured for automatic certificate renewal, you only need to run the `Build Action`; it detects no signing credentials are available and creates them
     * If that app is not configured for automatic certificate renewal, you must first run the action  `Create Certificates` and then `Build`
 
 ### Open-Source App Schedule
 
 Each Open-Source App has a schedule for when the automatic build happens. This determines when the automatic check for certificate status happens.
 
-The times are shifted to make sure only one Open-Source app performs a `nuke` process at one time. This only happens once a year, but we wanted to be sure there are no conflicts. Even if an app doesn't have automatic certificates implemented yet, they are added to the table as suggested values to use when this capability gets added. All times are UTC. If other apps decide to add this feature, please make a pull request to LoopDocs so we can add those times to the deconfliction table.
+The times are shifted to make sure only one Open-Source app performs a `nuke` action. Any other app building later that same day will just create new signing credentials; it will not need to `nuke` all credentials. This only happens once a year, but we wanted to be sure there are no conflicts. Even if an app doesn't have automatic certificates implemented yet, they are added to the table as suggested values to use when this capability gets added. All times are UTC. If other apps decide to add this feature, please make a pull request to LoopDocs so we can add those times to the deconfliction table.
 
-| Open-Source App | AutoCerts? | Wed Time | 1st of Month Time |
-|:--|:-:|--:|--:|
+| Open-Source App | AutoCerts? | Wed<br>UTC | 1st of Month<br>UTC |
+|:--|:-:|:-:|:-:|
 | <span translate="no">Loop</span> | `dev` only | 09:00 | 07:00 |
-| <span translate="no">LoopCaregiver</span> | n | 13:00 | 11:00 |
-| <span translate="no">LoopFollow</span> | y | 12:00 | 10:00 |
-| <span translate="no">LoopFollow_Second</span> | y | 12:20 | 10:20 |
-| <span translate="no">LoopFollow_Third</span> | y | 12:40 | 10:40 |
-| <span translate="no">Trio</span> | y | 08:00 | 06:00 |
+| <span translate="no">LoopCaregiver</span> | &#x2705; | 13:00 | 11:00 |
+| <span translate="no">LoopFollow</span> | &#x2705; | 12:00 | 10:00 |
+| <span translate="no">LoopFollow_Second</span> | &#x2705; | 12:20 | 10:20 |
+| <span translate="no">LoopFollow_Third</span> | &#x2705; | 12:40 | 10:40 |
+| <span translate="no">Trio</span> | &#x2705; | 08:00 | 06:00 |
 | <span translate="no">xDrip4iOS</span> | n | 16:00 | 14:00 |
 
 
@@ -150,7 +142,7 @@ This is an optional step. If you are happy with the automatic sync and update, y
     * If you want to only build when an update has been found:
         * either do not create the variable `SCHEDULED_SYNC` or set it to true
         * create the variable `SCHEDULED_BUILD` and set it to false
-        * **Warning**: if no updates to your default branch are detected within 90 days, your previous TestFlight build may expire requiring a manual build
+        * **Warning**: if no updates to your default branch are detected within 90 days, your previous TestFlight build may expire, requiring a manual build
         * During a time when updates are not happening frequently, this is not a good choice
 
     | <div style="width:120px">`SCHEDULED_SYNC`</div> | <div style="width:120px">`SCHEDULED_BUILD`</div> | Automatic Actions |

docs/browser/edit-browser.md

@@ -81,7 +81,7 @@ Decide which [Version: Custom Edits](../version/code-custom-edits.md){: target="
     * Do not get confused later: LoopKit is both a username and a Module name
     * Refer to the [Module Table](#module-table) when directed
 
-With the release of 3.4.x, the customizations for `main` and `dev` are the same. There are 2 customizations that require an update when moving from 3.2.3 to 3.4.x.
+For versions 3.4.x and newer, the customizations for `main` and `dev` are the same.
 
 * For more information, refer to [Not Stable List](../version/code-custom-edits.md#not-stable-list){: target="_blank" }
     * Glucose Guardrails
@@ -358,8 +358,6 @@ Once you prepare the commands, then you will edit the build_loop.yml file of you
     If your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;did not come from&nbsp;<span translate="no">LoopKit/LoopWorkspace</span>, then delete your existing <code>fork</code> and make a new one. See [Already Have&nbsp;<span translate="no">LoopWorkspace</span>?](prepare-fork.md#already-have-loopworkspace){: target="_blank" }.
 
     * Do not use any other location to create your <code>fork</code>
-    * You may have used a different location for Loop 3.2.2
-    * This is **not** supported for Loop 3.2.3 or later
 
 For each customization you want to include, create a pair of lines consisting of the comment (must start with a #) followed by the&nbsp;`curl`&nbsp;statement pointing to the SHA-1 that has the customization.
 
@@ -394,36 +392,6 @@ Return to your&nbsp;<span translate="no">GitHub fork for LoopWorkspace</span>&nb
 * Find the folder .github/workflows and click on it
 * Find the file build_loop.yml and click on it
 * Click on the pencil (so you can edit this file)
-* If you are building version 3.4
-    * Skip ahead to [Add Personal Customizations to build_loop.yml](#add-personal-customizations-to-build_loopyml)
-
-??? abstract "Older versions (Click to open/close)"
-    * If you are building from an older version of main (version 3.2.3 or earlier), this is left here for your convenience - it will be removed over the next few months - please update soon
-        * Locate line 31, which is just above the words:
-            * `# Patch Fastlane Match to not print tables`
-        * Paste the contents of the block below so it comes before that section
-        * In the next section - you will need to modify the line number where you do the edits
-
-
-    ``` { .text .copy title="Paste into build_loop.yml" }
-        # Customize Loop: Download and apply patches
-        - name: Customize Loop
-            run: |
-
-            # For each patch, edit comment line (keep the #) then update curl (and remove the #)
-
-            # Submodule Loop patches:
-            # Loop: Filename: customization details
-            #curl https://github.com/my-name-org/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
-            
-            # Submodule LoopKit patches:
-            # LoopKit: Filename: customization details
-            #curl https://github.com/my-name-org/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
-            
-            # Submodule xxxxx patches: Follow prototype above
-
-
-    ```
 
 ### Add Personal Customizations to build_loop.yml
 

docs/browser/identifiers.md

@@ -68,11 +68,6 @@ The `Validate Secrets` &nbsp;<span class=notranslate>Action</span>&nbsp; should
 
 ## <code>Add Identifiers</code>
 
-!!! warning "Update to Version 3.4"
-    The name and identifier for "`Small Status Widget`" was renamed to "`Loop Widget Extension`". If you previously built, you will need to run the Add Identifiers as directed on the [update page](bb-update.md#update-from-32x-to-34){: target="_blank" } to add the renamed Identifier and Create Certificates for it.
-
-    If you previously built the `dev` branch, you already have this identifier.
-
 ??? abstract "Section Summary (click to open/close)"
     1. Click on the "Actions" tab of your LoopWorkspace repository.
     1. On the left side, select "2. Add Identifiers".

docs/browser/intro-summary.md

@@ -88,6 +88,8 @@ If you prefer watching your instructions, there is a narrated video of each step
 
 * [How to Build the *Loop* App With a Web Browser](https://www.youtube.com/watch?v=kiu5ho0MTW8){: target="_blank" }
 
+> Do not decide to uncheck the box for Near Field Communications in the Identifer for `Loop` - that is required to build version 3.4.x and newer.
+
 Click in the comments for a full index of topics.  If you have issues with a particular section, use the index to advance to the relevant part of the video. Subtitles are in English. You can choose a different language but the automatic translation feature may provide translations that are not completely accurate.
 
 ### The Detailed Version

docs/browser/prepare-app.md

@@ -20,7 +20,7 @@ Some people get confused on this page. Many of the links look similar but are ac
         * App Group: associates different identifiers so the app works correctly - you will do this step under your Apple Developer ID account.
         * App: associates a particular identier as the main Loop code - you will do this step under the App Connect site which is associated with your developer ID but is a different URL.
 
-> This should only be needed one time, unless the developers add or modify an identifier. This happened between version 3.2 and version 3.4.
+> This should only be needed one time.
 
 Some steps can be skipped if you previously built the *Loop* app with a *Mac* using *Xcode*.
 
@@ -109,8 +109,6 @@ If you built previously using a Mac with Xcode, you may see the XCode version in
 
 #### Table with Name and Identifier
 
-> One Identifier was changed after v3.2.3. (`Small Status Widget` is now `Loop Widget Extension`).
-
 | NAME | XCode version | IDENTIFIER |
 |:--|:--|:--|
 | `Loop` | `XC com TEAMID loopkit Loop`| `com.TEAMID.loopkit.Loop` |
@@ -119,7 +117,6 @@ If you built previously using a Mac with Xcode, you may see the XCode version in
 | `Loop Widget Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
 | `WatchApp` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWatch` |
 | `WatchAppExtension` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWatch.watchkitextension` |
-| **v3.2** `Small Status Widget` | XC Identifier | `com.TEAMID.loopkit.Loop.SmallStatusWidget`<br>No longer used, harmless to leave or to delete<br>Replaced with `Loop Widget Extension` |
 
 ### Add `App Group` to Identifiers