Merge pull request #628 from marionbarker/working-docs

marionbarker · web-flow · commit 3f1646c5db41 · 2023-04-15T18:07:10.000-07:00
Update Customization and Loop Follow information
diff --git a/docs/build/code_customization.md b/docs/build/code_customization.md
diff --git a/docs/build/step14.md b/docs/build/step14.md
@@ -109,7 +109,7 @@ Go to the Finder app, click on Applications, then open the Utilities folder.  Lo
     * Please read each step as if you are a new builder
     * Don't assume you know what you are doing
     * [FreeAPS](https://www.loopandlearn.org/freeapsdoc) is no longer supported by the Build Select Script
-    * [Loop 3 with Patches](https://www.loopandlearn.org/github-lnl-patches) is provided instead
+    * [Loop 3 with Patches](https://www.loopandlearn.org/main-lnl-patches) is provided instead
 
 These instructions show each step needed to download Loop using the Build-Select script.
 
@@ -120,8 +120,8 @@ These instructions show each step needed to download Loop using the Build-Select
     
     Consider using Loop 3 as designed. If you need Libre or want the CustomTypeOne patches, those are provided in the Loop with Patches selection in the Build Select Script.
  
-     * Information about [Loop Follow](https://github.com/jonfawcett/LoopFollow#readme)
-     * Information about [Loop with Patches](https://www.loopandlearn.org/build-select/)
+     * Information about [Loop Follow](https://www.loopandlearn.org/loop-follow)
+     * Information about [Loop with Patches](https://www.loopandlearn.org/main-lnl-patches/)
         * Warning, the Loop with Patches is updated **after** the main Loop is released. Typically it is updated within a day, but don't assume. Check that link for updates.
  
      You do not need to know about these options to build Loop.
@@ -148,7 +148,7 @@ Next you will see an introduction to the Build-Select script.  Please read this.
 ![choose to build Loop](img/bss-02-menu-message.svg){width="700"}
 {align="center"}
 
-Next you are asked which version of Loop you would like to build. Type 1 and return to build Loop (as shown in the graphic below) or 2 for the fork of Loop with added Libre CGM options and CustomTypeOne patches.
+Next you are asked which version of Loop you would like to build. Type 1 and return to build Loop (as shown in the graphic below) or 2 for the fork of Loop with added Libre CGM options, CustomTypeOne patches and a custom logo.
 
 ![choose which Loop to build](img/bss-03-choose-fork.svg){width="700"}
 {align="center"}
diff --git a/docs/build/step4.md b/docs/build/step4.md
@@ -15,7 +15,7 @@
 
 !!! question "FAQs"
 
-    - **"What about Libre sensors?"** A [fork of Loop](https://www.loopandlearn.org/github-lnl-patches) is available with added Libre support
+    - **"What about Libre sensors?"** A [fork of Loop](https://www.loopandlearn.org/main-lnl-patches) is available with added Libre support
     - **"What about Eversense?"** Refer to [CGMs Not Supported in Loop](#cgms-not-supported-in-loop)
 
 
@@ -70,7 +70,7 @@ Loop 3 can use Nightscout as a remote source for CGM data. This requires cell or
 
 Loop does not directly support some CGM such as Libre, Eversense and Medtronic Guardian.
 
-* A [fork of Loop](https://www.loopandlearn.org/github-lnl-patches) is available with added Libre support
+* A [fork of Loop](https://www.loopandlearn.org/main-lnl-patches) is available with added Libre support
     * GitHub Build: Refer to the link above for instructions to build this fork
     * Mac-Xcode Build: Select the Loop with Patches option in the [Build Select Script](step14.md)
 
diff --git a/docs/build/testflight-xcode.md b/docs/build/testflight-xcode.md
@@ -6,7 +6,7 @@ There are several different methods for making use of TestFlight:
 * Use the GitHub [Browser Build](../gh-actions/gh-overview.md) method to build and distribute your own Loop app
 * Use TestFlight as a remote distribution (and backup) for an app you build using Xcode
 
-If you want to add specific customizations, [Customize your Loop](../build/code_customization.md), to your build, that can be more difficult with the GitHub method. There are a few customizations available from [Loop and Learn: Loop Customization](https://www.loopandlearn.org/github-lnl-patches), but some people prefer additional modifications.
+If you want to add specific customizations, [Customize your Loop](../build/code_customization.md), to your build, that can be more tedious with the GitHub method. There are a few (Prepared Patches) customizations available from [Loop and Learn: Loop Customization](https://www.loopandlearn.org/custom-code#prepared-patches), but some people prefer additional modifications. These prepared patches, from LnL or those you create yourself, are added to the build_loop.yml file in your LoopWorkspace fork.
 
 This guide can also be followed to install other apps you build with Xcode via TestFlight. Examples include LoopFollow, LoopCaregiver, xDrip4iOS and GlucoseDirect.
 
diff --git a/docs/faqs/FAQs.md b/docs/faqs/FAQs.md
@@ -174,7 +174,7 @@ One exception - if you've chosen to use a CGM source that does require the inter
 
 Many features people used with FreeAPS can be added to Loop 3 with customization. These customizations are supplied as a new branch, main_lnl_patches, on the loopnlearn GitHub site. This includes Libre support and the CustomTypeOne LoopPatches.
 
-* The customizations are described in [Loop and Learn: Loop Customization](https://www.loopandlearn.org/github-lnl-patches)
-* For Browser Build, use the GitHub instructions in LoopDocs but fork from loopnlearn GitHub instead of LoopKit as explained [Loop and Learn: GitHub Loop with Patches](https://www.loopandlearn.org/github-lnl-patches/#github)
+* The customizations are described in [Loop and Learn: Loop Customization](https://www.loopandlearn.org/main-lnl-patches)
+* For Browser Build, follow the direction on the page above
 * For Mac-Xcode build, these customization were incorporated as an option in the [Build Select Script](../build/step14.md).
 
diff --git a/docs/faqs/cgm-faqs.md b/docs/faqs/cgm-faqs.md
@@ -1,6 +1,6 @@
 ## What CGMs does Loop work with?
 
-Loop 3 supports G5, G6, G7, Dexcom ONE, Dexcom Share, Nightscout and the Medtronic CGM systems compatible with Looping pumps. [Loop and Learn: Loop Customization](https://www.loopandlearn.org/github-lnl-patches) can be used which adds support for some Libre sensors.
+Loop 3 supports G5, G6, G7, Dexcom ONE, Dexcom Share, Nightscout and the Medtronic CGM systems compatible with Looping pumps. [Loop and Learn: Loop Customization](https://www.loopandlearn.org/main-lnl-patches) can be used which adds support for some Libre sensors.
 
 Loop 2.2.x supports Dexcom G4 with share, G5, G6, Dexcom ONE, Dexcom Share and the Medtronic CGM systems compatible with Looping pumps.
 
@@ -82,7 +82,7 @@ If you want to use a Libre sensor you will need to modify Loop to accomplish tha
 
 With Loop 3, a customization can be used to support some Libre sensor CGM.
 
-Please refer to [Loop and Learn: Loop 3 with Customization](https://www.loopandlearn.org/github-lnl-patches/)
+Please refer to [Loop and Learn: Loop 3 with Customization](https://www.loopandlearn.org/main-lnl-patches/)
 
 ## Can I use Eversense?
 
diff --git a/docs/gh-actions/gh-customize.md b/docs/gh-actions/gh-customize.md
@@ -1,22 +1,20 @@
 ## Hot Topics
 
 !!! tip "Pro Tip"
-    You can also use this same method to create a set of personal patches. You can use (and re-use) your patches with Mac-Xcode builds so you don't have to repeat the customization with every update.
+    The method on this page allows you to create a set of personal patches. You can use (and re-use) your patches with Mac-Xcode builds so you don't have to repeat the customization with every update.
 
     * If you are building with Mac-Xcode method, you will use the same lines found in the [Prepare the Patches](#prepare-the-patches) section, but will paste them in your terminal to customize your code
 
-!!! 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.
-
-    * 27-March 2023: Method updated and modified
-        * Improvement, you can reuse the customization with each update unless there is a conflict
-        * You will paste the patch into the build_loop.yml file (we'll tell you how)
-
-    WARNING - After a recent release - wait for the release number to be updated on this page before using any of the copy/paste commands.
+!!! warning "Submodule Instructions"
+    This page has instructions to prepare branches for the Modules associated with LoopWorkspace that exactly match the current release. You can then edit that code and save (commit) the change to **your fork** to prepare your personal patch. 
+    
+    **Please do not click on boxes that GitHub might show you that ask if you want to merge changes from your fork back to LoopKit.** These changes are for **your fork** only. Ignore those prompts.
+    
+    * You can often use the same patch for several releases
+    * If a patch that you prepared for an older release says "patch does not apply" when you use it, you'll need to prepare a new one
+    * Please wait for this page to be updated to the current release before generating an updated patch
 
-    This page was updated for Loop 3.2.1 on 22-March-2023.
+    This page is valid for Loop 3.2.1.
 
 ## Overview
 
@@ -113,13 +111,18 @@ curl https://github.com/username/Module/commit/SHA-1.patch | git apply -v --dire
 
 where:
 
+* `curl` means copy from URL
 * username is your GitHub username
 * Module is where you made the customization (notice it is in multiple places)
 * SHA-1 is the full identifier for the commit that has the change; there is a copy button to make this easy
-* the `.patch` after the SHA-1 is github magic that formats that code change into a patch
+* the `.patch` after the SHA-1 is GitHub magic that formats that code change into a patch
+
+To view the exact code change associated with that patch, open a browser at the URL of `https://github.com/username/Module/commit/SHA-1`.
 
 ## Create a Fork for Selected Module
 
+### Code Updates
+
 !!! warning "New Release"
     If you have previously used this process for a prior release, use the same Modules you already forked.
 
@@ -134,7 +137,9 @@ where:
 
     Skip ahead to [Open Module in Codespaces](#open-module-in-codespaces).
 
-If you want a modification that uses a particular module, you must fork that module to your GitHub account. You will repeat the Fork and Modify steps for each module.
+### New Fork
+
+If you want a modification that uses a particular Module, you must fork that module to your GitHub account. You will repeat the Fork and Modify steps for each module.
 
 1. Log into your GitHub account
 1. Right click (or control click) on the URL in the table above
@@ -167,9 +172,9 @@ When you fork a repository, the default branch is the one that is forked. That i
 This page has instructions for applying customizations to released code, main branch of LoopWorkspace. Don't worry that some of the other repositories have dev for the default branch. With the exception of the Loop module, everything you need to create your patches is included in the default branches of the lower level repositories (Modules). For Loop, you will also need a main branch. See [Connect Fork to New Branch](gh-update.md#connect-fork-to-new-branch)
 
 !!! warning "Loop with LnL Patches"
-    Some Loop users build with the loopnlearn version of LoopWorkspace using the main_lnl_patches branch. At the current time, this process involves making your LoopWorkspace fork from loopnlearn instead of LoopKit. In the future, you will be able to get the same patches by a different method.
+    Some Loop users build with the loopnlearn version of LoopWorkspace using the [main_lnl_patches](https://www.loopandlearn.org/main-lnl-patches) branch. Initially, this process involved making your LoopWorkspace fork from loopnlearn instead of LoopKit. You have the option of deleting that fork and starting over with LoopKit and apply those same patches in the build-loop.yml file of your new fork, see [Loop and Learn: LnL Patches](https://www.loopandlearn.org/custom-code/#lnl-patches).
 
-    The process for creating your own customized patch is the same as those using the released code. There will be extra information about modifying the build_loop.yml depending on which LoopWorkspace you choose to fork (LoopKit or loopnlearn). But that documentation is not ready yet.
+    The process for creating your own customized patch is the same as those using the released code.
 
 ## Open Module in Codespaces
 
@@ -348,8 +353,6 @@ For each modification, there is a `Key_Phrase` to help you find the line of code
 
 Click on the codespaces magnifying glass, paste the `Key_Phrase` into the search bar. If you use the copy icon and paste the `Key_Phrase`, you'll need to hit backspace to remove the extra return.
 
-TO DO - put in a GIF showing making changes.
-
 Make the change and save the file.
 
 The source control icon now has a number showing. The number is how many different files in this Module that you have modified. Sometimes, more than one customization is added to a given file.
@@ -380,7 +383,7 @@ You are done with this module.
 Click the Codespaces icon at bottom left.
 Choose Stop Codespace from the menu. Don't worry about the changes won't be saved message - you just saved the changes with the sync command above.
 
-The screen will then show the Codespace is stopped message. You can close the tab.
+The screen will then show the Codespace is stopped message.
 
 Return to your github account and look at the repository for the Module you just changed. It should be similar to the graphic below.
 
@@ -389,9 +392,13 @@ Return to your github account and look at the repository for the Module you just
 
 ## Prepare the Patches
 
-While you have this Module open, go on an prepare the patch lines you will need to add to the build_loop.yml file.
+You will prepare the patches looking at your fork of the Submodule repository under GitHub. Look at your fork, your __main_3.2.1_custom__ branch and click on the clock icon to the right to see the commit history. Each commit has a copy button you can use to copy the full SHA-1 for that commit; and a link you can click to see the changes and comments for that commit.
 
-Add graphic showing several customizations with comments.
+**Please do not click on boxes that GitHub might show you that ask if you want to merge changes from your fork back to LoopKit.** These changes are for **your fork** only. Ignore those prompts.
+
+You will need the SHA-1 and the commit comment for each change you made in main_3.2.1_custom.
+
+Add graphic showing GitHub fork with several customizations with comments.
 
 Important: work from older (bottom) to newer (top) commits when creating the patches.
 
@@ -462,6 +469,8 @@ The indenting needs to match, so tab or (shift-tab) to line up the patches.
     * Click on Run workflow on the right side
     * Then click on the green Run Workflow button
 
+After waiting about 2 minutes, to make sure there is no error, return to [Codespaces](https://github.com/codespaces). Scroll to the bottom of the screen and delete any codespaces you created above. (Note codespaces must first be stopped and then deleted.)
+
 In about 1 hour, your customized Loop will be available for installation on your phone via TestFlight.
 
 ## Special Cases
@@ -494,7 +503,7 @@ What if you already have a fork of one of the modules?
 
 **Your existing fork is from a username other than LoopKit**
 
-If your fork is from loopnlearn then you need to follow the directions (that are not written yet) on the loopandlearn dot org website.
+If your fork is from loopnlearn and you want additional customizations, it is easist to delete that fork, make a new one from LoopKit, add the 6 Secrets to the new fork and as part of the changes to build_loop.yml, add the [Loop and Learn: LnL Patches](https://www.loopandlearn.org/custom-code/#lnl-patches) and you additional customizations.
 
 If you know this is a fork you do not care about, you can delete the repository.
 
diff --git a/docs/gh-actions/gh-other-apps.md b/docs/gh-actions/gh-other-apps.md
@@ -74,7 +74,7 @@ Once all six Secrets are added, you will either continue to add the identifiers
 
 ## Action: Validate Secrets
 
-When building Loop Follow, the main branch has the new steps that are currently in [Loop dev Actions](gh-update.md#loop-dev-actions) and will be in the next release. The actions will look slightly different than when you built Loop.
+The first action step is to Validate Secrets.
 
 ![actions shown for Loop 3.1 and newer versions](img/gh-actions-3.1.png){width="200"}
 {align="left"}
diff --git a/docs/gh-actions/gh-overview.md b/docs/gh-actions/gh-overview.md
@@ -20,11 +20,9 @@ TestFlight is the only method available for installation to a phone when using t
 
 ### Cons
 
-The customization process is more involved. One set of commonly requested customizations is available, as explained at [Loop and Learn: Loop Customization](https://www.loopandlearn.org/github-lnl-patches).
+The customization process is more tedious to set up but then easy to maintain. One set of commonly requested customizations is available, as explained at [Loop and Learn: Loop Customization](https://www.loopandlearn.org/custom-code#prepared-patches).
 
-* Stick with Mac-Xcode build (for now) if you want to do your own customizations
-    * You can still use [TestFlight with your Mac-Xcode build](../build/testflight-xcode.md)
-* If you still want customizations and don't have a Mac-Xcode system that allows you to customize, there are now instructions at Browser Build  [Customize with GitHub](../gh-actions/gh-customize.md)
+* There are now instructions at Browser Build  [Customize with GitHub](../gh-actions/gh-customize.md)
     * These instructions are for released code
 
 ## Requirements
diff --git a/docs/nightscout/ns_crossref.md b/docs/nightscout/ns_crossref.md
@@ -24,11 +24,11 @@ While the Loop app sends notifications locally on the Loop user's iPhone, parent
 
 ### Loop Follow
 
-Loop Follow was created by Jon Fawcett who took ideas from multiple other apps to create a single app to assist in his caregiving role. It is popular with Loopers who like the display and notifications as well as Loop caregivers. It can work with just the Dexcom Share credentials and/or the Nightscout URL and allows for easy customization of alerts and alarms.
+Loop Follow was created by Jon Fawcett who took ideas from multiple other apps to create a single app to assist in his caregiving role. It is popular with Loopers who like the display and notifications as well as Loop caregivers. It can work with just the Dexcom Share credentials and/or the Nightscout URL and allows for easy customization of alerts and alarms. Jon has handed over maintenance of this app to the Loop and Learn team.
 
 * Please see
-    * [Loop Follow github README](https://github.com/jonfawcett/LoopFollow/#loop-follow)
-    * [Loop Follow Facebook group](https://www.facebook.com/groups/loopfollow)
+    * [Loop and Learn: Loop Follow page](https://www.loopandlearn.org/loop-follow)
+    * [Loop and Learn Facebook group](https://www.facebook.com/groups/loopandlearn)
 
 ## Pebble Watch
 
diff --git a/docs/operation/features/notifications.md b/docs/operation/features/notifications.md
@@ -164,5 +164,4 @@ Many people use additional apps to assist in following a loved one or to support
 
 ![loop follow graphic from the README page](img/loop-follow.png)
 
-For more information, please read the [Loop Follow](https://github.com/jonfawcett/LoopFollow#loop-follow) documentation. You can build Loop Follow using the same [Build Select Script](../../build/step14.md#build-select-script) you used to build the Loop app. (It's one of the options in the menu.)
-
+For more information, please read the [Loop Follow](https://www.loopandlearn/loop-follow) documentation. You can build Loop Follow using the same [Build Select Script](../../build/step14.md#build-select-script) you used to build the Loop app or using the [GitHub Browser Build Method](../../gh-actions/gh-other-apps.md).
