Merge pull request #773 from marionbarker/working-docs

Update Navigation to make Browser and Mac build methods more parallel

README.md

@@ -195,35 +195,34 @@ If the word is at the end of a line or has other punctuation, the ` ` can b
 
 ### All about&nbsp;<span translate="no">Word</span>
 
-This ability to build&nbsp;<span translate="no">Loop</span>, from both a browser and with Mac-Xcode, is wonderful.
+This ability to build&nbsp;<span translate="no">Loop</span> from either a browser or using a *Mac* is wonderful.
 ```
 
 Be warned that if `&nbsp;` is part of the text in a header, the automatic link doesn't acknowledge the space. The link above would be `#all-aboutword`, not `#all-about-word`.
 
 If you want italic font with `span`, I choose to use underscore instead of asterick to make the word show up as italic font because I think that helps with clarity (opinion only):
 ```
-This ability to build&nbsp;_<span translate="no">Loop</span>_, from both a browser and with Mac-Xcode, is wonderful.
+This ability to build&nbsp;_<span translate="no">Loop</span>_, from both a browser and with *Mac*, is wonderful.
 ```
 
 
 These words / phrases **do not need** no-translate tags, however, they are typically rendered in italics (use astericks on either side):
 
 * Xcode
-* Mac-Xcode
-* GitHub
-* TestFlight
-
-These words **do need** no-translate tags (most of the time):
-* Apple
-* Loop
-* LoopKit/Loop
+* *Mac*
+* *GitHub*
+* *TestFlight*
+* *Apple*
 
 Look out for Loop showing up as buckle, at least in French and Spanish, in translations. That indicates `span` must be used, with the `&nbsp;` required if there is no punctuation mark. Once again, using underscore instead of asterisk in concert with `span` is a preference:
 
 ```
 &nbsp;_<span translate="no">Loop</span>_&nbsp;
 ```
 
+The no-translate tags can be avoided if used in a phrase:
+* the *Loop* app
+
 Common words like `Secrets` that will show up on `GitHub` for Building with Browser should be enclosed in `code` so tooltips will work and the word will be highlighted as important.
 
 From Eric (his rules before Marion made comments above)

docs/build/apple-developer.md

@@ -10,7 +10,7 @@
 
     - Paid Developer Account: Go to the [Apple Developer website](https://developer.apple.com/programs/enroll/) to enroll in an individual account.
     - Free: No action required at this time.
-        * Free requires you to use the Mac-Xcode build method
+        * Free requires the [Build with *Mac*](overview.md) method
 
 !!! question "FAQs"
     - **"Can I use someone else's Apple Developer account?"** Please refer to this [Answer](../faqs/FAQs.md#can-i-use-someone-elses-apple-developer-account).
@@ -29,7 +29,7 @@ The Apple ID is DIFFERENT than the Apple Developer ID.
     Sharing an Apple ID among two or more loopers can cause safety issues. You don't want Sally to be dosed for Joe's lunch in addition to her own and vice versa.
 
     * The recommendation for Health Permissions for [Loop 2.2.x](health.md#loop-permissions) has changed to no longer provide permission to read Carbohydrates from Apple Health
-    * Loop 3 does not read Carbohydrates from Apple Health by default, but if you need that feature, you can [modify your feature flags](code-customization.md#build-time-features).
+    * Loop 3 does not read Carbohydrates from Apple Health by default, but if you need that feature, you can [modify your feature flags](../version/build-time-flag.md).
 
 ## Developer Account
 
@@ -41,7 +41,7 @@ You have two options for an individual account: free or paid.
 
 If you decide to use a **FREE** developer account, here's what you need to know:
 
-1. You must use the [Mac-Xcode Build](../build/overview.md) method to build Loop.
+1. You must use the [Build with *Mac*](../build/overview.md) method to build Loop.
 1. Loop apps signed with a free developer account will expire after 7 days.  On the 7th day, your Loop app will simply turn white when you open it and then immediately close. To rebuild the Loop app, you will have to find a computer and rebuild the app onto your iPhone again. You cannot rebuild the app on day 5 (when it is convenient, for example), hoping to reset the 7-day clock.  The app will still expire on the 7th day from when it was first signed and created.
 2. If you decide to switch to a paid account after trying out the free account, you will need to rebuild your Loop app to sign it with the new paid account. Furthermore, switching from a [Free to a Paid](apple-developer.md#switching-from-free-to-paid-memberships) account requires entering all the settings again (and starting a fresh pod).
 3. You will have to do an extra step during the build process to remove Siri and Apple Push capabilities to build with free accounts. Because free accounts do not have access to Apple Push notifications, you will also not be able to use [Remote Commands](../nightscout/remote-overview.md) through Nightscout.
@@ -55,7 +55,7 @@ If you decide to use a **PAID** developer account, here's what you need to know:
 1. If you use the Browser Build method
     * You must [Update with Browser](../gh-actions/gh-update.md) the build once every 90 days
     * You must have a Paid Developer account
-1. If you use the Mac-Xcode Build method
+1. If you use the Build with *Mac* method
     * If you have a paid developer account, you must build at least once a year
     * If you have a free account, you must build every 7 days
 

docs/build/build-app.md

@@ -412,6 +412,11 @@ The Loop app on your phone closes (but does not quit) when you unplug the phone.
 
 If you plan to build again on a backup phone, or want to try a customization, easiest for you to leave Xcode open. Otherwise, you can quit out of Xcode now.
 
+But wait - there's more.
+
+* Caregivers who help manage a loved-ones diabetes often use other open-source apps that can be built the same way
+* When you are done building and installing the *Loop* app, there are instructions on the *Loop and Learn* website to [Download and Build Related Apps](https://www.loopandlearn.org/build-select/#build-other-apps)
+
 ## Protect that App
 
 !!! danger "Protect Against Deletion"
@@ -463,7 +468,7 @@ Even if you don't read all the pages under the Set Up tab now, these links are i
 !!! tip "Pro Tip"
     With a fresh download of code, it's always best to build to a simulator without customization to ensure the build works without errors. Then add the customizations and check the build again. Now you are ready to build to your phone to update your existing app.
 
-To add custom configurations to your Loop or Loop Apple Watch apps, follow the step-by-step instructions on the [Code Customizations](code-customization.md) page and then build the app again.
+To add custom configurations to your Loop or Loop Apple Watch apps, follow the step-by-step instructions on the [Code Customizations](custom-mac.md) page and then build the app again.
 
 
 ### Apple Watch
@@ -476,7 +481,7 @@ For more information, please see [Operate: Apple Watch](../operation/features/wa
 
 ### Build Again with this Download
 
-Follow the [Find My Downloaded Loop Code](code-customization.md#find-my-downloaded-loop-code) instructions if you later wish to build with this same dowload. Plug in an unlocked phone and start at the [Start Build](#start-build) section of this page. You may need to select the phone you just plugged in. Everything else should be ready for you the start the build process.
+Follow the [Find My Downloaded Loop Code](custom-mac.md#find-my-downloaded-loop-code) instructions if you later wish to build with this same dowload. Plug in an unlocked phone and start at the [Start Build](#start-build) section of this page. You may need to select the phone you just plugged in. Everything else should be ready for you the start the build process.
 
 !!! warning "Don't use a really old download"
     Do not use a really old download.

docs/build/build-dev-mac.md

@@ -0,0 +1,56 @@
+## Overview
+
+
+**This page is only relevant when building the `dev` branch with a *Mac*.**
+
+**For *Browser Build*, please see: [Build Loop dev with Browser](../gh-actions/build-dev-browser.md)**
+
+**No matter the method used to build Loop-dev, you are testing development code. Please read this link now before continuing.**
+
+* **[What's going on in the `dev branch`](../version/development.md#whats-going-on-in-the-dev-branch)**
+
+## `BuildLoopDev` Script
+
+There is a script to assist in building the `dev branch`. It gives you the option to choose the tip of the `dev branch` or to build a lightly tested commit. If you have not used the [Build Select Script](../build/build-app.md#build-select-script) to build Loop previously, you may want to review that page. The command below can be pasted into the terminal of your Mac. Read the directions in the script.
+
+``` { .bash .copy title="Copy and Paste to start the BuildLoopDev script" }
+/bin/bash -c "$(curl -fsSL \
+  https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoopDev.sh)"
+```
+Both the `dev branch` and the lightly tested branch of `dev` have Libre support.
+
+### BuildLoopDev Other Branches
+
+You can use the BuildLoopDev script to build a specific development branch, other than `dev`. See the example below that would build `other-branch`, if such a branch existed. This is just an example. You need to substitute the branch you desire for `other-branch`. There must be a space after the final quote, followed by a hyphen, another space and then the branch name.
+
+``` { .bash .copy title="Example using <code>other-branch</code> with the BuildLoopDev script" }
+/bin/bash -c "$(curl -fsSL \
+  https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoopDev.sh)" - other-branch
+```
+
+## Update Loop-dev
+
+While Loop-dev is under active development, you should monitor zulipchat and update frequently.
+
+Checking for updates every week is a good idea. Also - subscribe to all the streams on [Loop Zulipchat](https://loop.zulipchat.com) to make sure you don't miss critical information.
+
+You may choose to download fresh each time you update. 
+
+You may prefer to use commands to fetch and pull the latest code without making a new clone.
+
+* Some users like to use [GitKraken](https://support.gitkraken.com/) to assist them (link takes you to a tutorial video).
+* Some are comfortable with the command line git commands described on [here](../version/loopworkspace.md#updating-loop-using-loopworkspace).
+
+## Loop-dev Version
+
+The version of code that shows up under the Loop Settings screen does not change when the `dev branch` is modified.
+
+If you need help with your app, the mentors need more information. Please issue a Loop Report when asking for help. Refer to [Support](../loop-3/settings.md#support) for how to issue a Loop Report. If you want to keep track yourself, refer to [Identify Loop-dev Version](#identify-loop-dev-version)
+
+* [`Loop` Version Numbering](../version/releases.md#loop-version-numbering)
+
+### Identify Loop-dev Version
+
+The version of code that shows up under the Loop Settings screen will remain fixed until Loop-dev is released. In order to identify which version of dev you have on your phone, you need the commit.
+
+The commit is identified by a 7-digit alphanumeric code.  That code was also appended to the folder name of the downloaded code under Downloads/BuildLoop as shown in the graphic above.  You can use finder to view the folder name after the script completes. It also appears in the Loop Report, refer to [Support](../loop-3/settings.md#support) for instructions on issuing a Loop Report. After you issue the Loop Report, look at the workspaceGitRevision number near the beginning of the report.

docs/build/build-errors.md

@@ -42,7 +42,7 @@ Before you start trying to resolve your red errors, start with the most obvious
 
 1. **Did you get a fresh download of Loop code?** If you tried to build with an old download that you used a long time ago, that old version may not be compatible with the new iOS and Xcode versions. Check also, that you are actually using the new download in Xcode.  When you use the Build Select Script, it automatically opens Xcode using the new download.
 
-    If you want to build using a recent download, this section tells you how to [Find My Downloaded Loop Code](code-customization.md#find-my-downloaded-loop-code).
+    If you want to build using a recent download, this section tells you how to [Find My Downloaded Loop Code](custom-mac.md#find-my-downloaded-loop-code).
 
 1. **Are you are using a free developer account?** Make sure you finished the removal of Siri and Push Notification capabilities described in the [Free Account](build-free-loop.md#free-account) link.