Formatting tweaks for easier regexp replace later

Author: heiskr

.github/steps/1-first-codespace.md

@@ -1,3 +1,11 @@
+<!--
+  <<< Author notes: Step 1 >>>
+  Choose 3-5 steps for your course.
+  The first step is always the hardest, so pick something easy!
+  Link to docs.github.com for further explanations.
+  Encourage users to open new tabs for steps!
+-->
+
 ## Step 1: Create your first codespace and push code
 
 _Welcome to "Develop code using GitHub Codespaces and Visual Studio Code"! :wave:_
@@ -33,23 +41,23 @@ To begin developing using GitHub Codespaces, you can create a codespace from a t
 1. From inside the codespace in the VS Code explorer window, select the `index.html` file.
 1. Replace the **h1** header with the below:
 
-```
-<h1>Hello from the codespace!</h1>
-```
+   ```html
+   <h1>Hello from the codespace!</h1>
+   ```
 
 1. Save the file.
    > **Note**: The file should autosave.
 1. Use the VS Code terminal to commit the file change by entering the following commit message:
 
-```
-git commit -a -m "Adding hello from the codespace!"
-```
+   ```shell
+   git commit -a -m "Adding hello from the codespace!"
+   ```
 
 1. Push the changes back to your repository. From the VS Code terminal, enter:
 
-```
-git push
-```
+   ```shell
+   git push
+   ```
 
 1. Your code has been pushed to your repository!
 1. Switch back to the homepage of your repository and view the `index.html` to verify the new code was pushed to your repository.

.github/steps/2-custom-image.md

@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 2 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 2: Add a custom image to your codespace!
 
 _Nice work! :tada: You created your first codespace and pushed code using VS Code!_
@@ -15,23 +21,23 @@ Let's add a `devcontainer.json` file and add a custom image.
 1. Navigating back to your **Code** tab of your repository, click the **Add file** drop-down button, and then click `Create new file`.
 1. Type or paste the following in the empty text field prompt to name your file.
 
-```
-.devcontainer/devcontainer.json
-```
+   ```
+   .devcontainer/devcontainer.json
+   ```
 
 1. In the body of the new **.devcontainer/devcontainer.json** file, add the following content:
 
-```
-{
-    // Name this configuration
-    "name": "Codespace for Skills!",
-    // Use the base codespace image
-    "image": "mcr.microsoft.com/vscode/devcontainers/universal:latest",
+   ```jsonc
+   {
+     // Name this configuration
+     "name": "Codespace for Skills!",
+     // Use the base codespace image
+     "image": "mcr.microsoft.com/vscode/devcontainers/universal:latest",
 
-    "remoteUser": "codespace",
-    "overrideCommand": false
-}
-```
+     "remoteUser": "codespace",
+     "overrideCommand": false
+   }
+   ```
 
 1. Click **Commit changes** and then select **Commit changes directly to the `main` branch**.
 1. Create a new codespace by navigating back to the **Code** tab of your repository.
@@ -43,6 +49,6 @@ Let's add a `devcontainer.json` file and add a custom image.
 
 1. Verify that your new codespace is is running, as you did previously.
 
-Note the image being used is the default image provided for GitHub Codespaces. It includes runtimes and tools for Python, Node.js, Docker, and more. See the full list here: https://aka.ms/ghcs-default-image. Your development team can use any custom image that has the necessary prerequisites installed. For more information, see [codespace image](https://aka.ms/configure-codespace).
+   Note the image being used is the default image provided for GitHub Codespaces. It includes runtimes and tools for Python, Node.js, Docker, and more. See the full list here: https://aka.ms/ghcs-default-image. Your development team can use any custom image that has the necessary prerequisites installed. For more information, see [codespace image](https://aka.ms/configure-codespace).
 
 1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.

.github/steps/3-customize-codespace.md

@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 3 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 3: Customize your codespace!
 
 _Nice work! :tada: You created a codespace with a custom image!_
@@ -11,7 +17,7 @@ Let's customize some settings in the `.devcontainer.json` file!
 1. Navigate to the `.devcontainer/devcontainer.json` file.
 1. Add the following customizations to the body of the file before the last `}`.
 
-```
+   ```jsonc
     ,
     // Add the IDs of extensions you want installed when the container is created.
     "customizations": {
@@ -26,7 +32,7 @@ Let's customize some settings in the `.devcontainer.json` file!
             ]
         }
     }
-```
+   ```
 
 1. Click **Commit changes** and then select **Commit changes directly to the `main` branch**.
 1. Create a new codespace by navigating to the landing page of your repository.
@@ -40,7 +46,7 @@ Let's customize some settings in the `.devcontainer.json` file!
 1. The `codespace.md` file should show up in the VS Code editor.
 1. The `copilot` extension should show up in the VS Code extension list.
 
-This will add a VS Code extension as well as open a file on start up of the codespace.
+   This will add a VS Code extension as well as open a file on start up of the codespace.
 
 Next lets add some code to run upon creation of the codespace!
 
@@ -49,10 +55,10 @@ Next lets add some code to run upon creation of the codespace!
 1. Edit the `.devcontainer/devcontainer.json` file.
 1. Add the following postCreateCommand to the body of the file before the last `}`.
 
-```
+   ```jsonc
     ,
     "postCreateCommand": "echo '# Writing code upon codespace creation!'  >> codespace.md"
-```
+   ```
 
 1. Click **Commit changes** and then select **Commit changes directly to the `main` branch**.
 1. Create a new codespace by navigating to the landing page of your repository.

.github/steps/4-personalize-codespace.md

@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 4 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 4: Personalize your codespace!
 
 _Nicely done customizing your codespace!_ :partying_face:
@@ -28,32 +34,33 @@ Let's see how this works!
    > Wait about **2 minutes** for the codespace to spin itself up.
 
 1. Verify your codespace is running. The browser should contain a VS Code web-based editor and a terminal should be present such as the below:
+
    ![codespace1](https://user-images.githubusercontent.com/26442605/207355196-71aab43f-35a9-495b-bcfe-bf3773c2f1b3.png)
 
 1. From inside the codespace in the VS Code explorer window, create a new file `setup.sh`.
 1. Add the following code inside of the file:
 
-```
-#!/bin/bash
+   ```bash
+   #!/bin/bash
 
-sudo apt-get update
-sudo apt-get install sl
-```
+   sudo apt-get update
+   sudo apt-get install sl
+   ```
 
 1. Save the file.
    > **Note**: The file should autosave.
 1. Commit the file changes. From the VS Code terminal enter:
 
-```
-git add setup.sh --chmod=+x
-git commit -m "Adding setup.sh from the codespace!"
-```
+   ```shell
+   git add setup.sh --chmod=+x
+   git commit -m "Adding setup.sh from the codespace!"
+   ```
 
 1. Push the changes back to your repository. From the VS Code terminal, enter:
 
-```
-git push
-```
+   ```shell
+   git push
+   ```
 
 1. Switch back to the homepage of your repository and view the `setup.sh` to verify the new code was pushed to your repository.
 1. Close the codespace web browser tab.
@@ -65,9 +72,9 @@ git push
 1. Verify the `setup.sh` file is present in your VS Code editor.
 1. From the VS Code terminal, type or paste:
 
-```
-/usr/games/sl
-```
+   ```shell
+   /usr/games/sl
+   ```
 
 1. Enjoy the show!
 1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.

.github/steps/X-finish.md

@@ -1,3 +1,8 @@
+<!--
+  <<< Author notes: Finish >>>
+  Review what we learned, ask for feedback, provide next steps.
+-->
+
 ## Finish
 
 _Congratulations friend, you've completed this course!_

.github/workflows/1-first-codespace.yml

@@ -1,4 +1,4 @@
-name: Step 1, 1-Create codespace and push code
+name: Step 1, Create codespace and push code
 
 # This step triggers after push to main.
 # This workflow updates from step 1 to step 2.

.github/workflows/2-custom-image.yml

@@ -1,4 +1,4 @@
-name: Step 2, 2-custom image check
+name: Step 2, Custom image check
 
 # This step triggers after First Codespace.
 # This workflow updates from step 2 to step 3.

.github/workflows/3-customize-codespace.yml

@@ -1,4 +1,4 @@
-name: Step 3, 3-Customize Codespace
+name: Step 3, Customize Codespace
 
 # This step triggers after we push to main.
 # This workflow updates from step 3 to step 4.

.github/workflows/4-personalize-codespace.yml

@@ -1,4 +1,4 @@
-name: Step 4, 4-Personalize your Codespace
+name: Step 4, Personalize your Codespace
 
 # This step triggers after push to main#setup.sh.
 # This workflow updates from step 4 to step X.

README.md

@@ -62,6 +62,11 @@ In this course, you will:
 
 <footer>
 
+<!--
+  <<< Author notes: Footer >>>
+  Add a link to get support, GitHub status page, code of conduct, license link.
+-->
+
 ---
 
 Get help: [Review the GitHub status page](https://www.githubstatus.com/)