Merge pull request #831 from marionbarker/working-docs

Fix typo, improve secrets reference file
LoopKit · May 11, 2024 · f2ed4da · f2ed4da
2 parents d2e8602 + af0272e
commit f2ed4da
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/docs/gh-actions/gh-errors.md b/docs/gh-actions/gh-errors.md
@@ -485,7 +485,7 @@ The graphic below shows the steps to make sure your `fork` is up to date and to
 
 #### Edit your Fastfile
 
-1. Type either ++command+"C"++ (Mac) or ++control+"C"++ (PC) to reveal the find and replace dialog shown in the graphic below
+1. Type either ++command+"F"++ (Mac) or ++control+"F"++ (PC) to reveal the find and replace dialog shown in the graphic below
     * Copy the phrase indicated below and paste it into the find buffer, and then type into the replace buffer the build number you want to require (one more than indicated by your last error)
 
     ``` { .txt .copy }

diff --git a/docs/gh-actions/gh-first-time.md b/docs/gh-actions/gh-first-time.md
@@ -86,7 +86,9 @@ You don't need to know anything about the <code>Secrets</code> or any other step
     * Create a blank <code>Secrets</code> Reference file using the text-only editor
     * Tap on the copy icon below to copy the template and paste it into your blank file
     * Save the file
-3. As you move through the steps on this page, fill in the parts of the template that say `<your information here>`
+3. As you move through the steps on this page, fill in the file
+    * The `##` characters are used to indicate sections or title (text only file)
+    * The there is a reference pattern for each SECRET, replace that with your SECRET
 4. In addition to the <code>Secrets</code>, this template has places for other pieces of information you may find handy to save in the same file.
 
 ``` { .bash .copy title="Template to use for Secrets" }
@@ -97,11 +99,11 @@ The same secrets are used for every app you build.
 
 First some handy username and password information:
 
-Apple ID username for your Developer account is the associated email:
+## Apple ID username for your Developer account is the associated email:
 <your information here>
 suggest you use your desired password tool to save the password for this account
 
-GitHub username
+## GitHub username
 <your information here>
 suggest you use your desired password tool to save the password for this account
 
@@ -115,7 +117,7 @@ including -----BEGIN PRIVATE KEY-----
 through
 -----END PRIVATE KEY-----
 
-SECRETS BELOW:
+## SECRETS BELOW:
 
 FASTLANE_ISSUER_ID
 <looks like this>
@@ -147,7 +149,7 @@ TEAMID
 <looks like this>
 AAAAAAAAAA
 
-Repository Names for my Fork:
+## Repository Names for my Fork:
 
 https://github.com/my-github-username/LoopWorkspace