r-devel · avinab-neogy · Mar 13, 2025 · Mar 13, 2025 · Mar 16, 2025 · Mar 16, 2025
diff --git a/docs/container_setup/github_codespace/codespacestartstop.md b/docs/container_setup/github_codespace/codespacestartstop.md
@@ -1,68 +1,76 @@
 
 
-#### How to Stop Codespaces?
-- To stop codespaces we just need to navigate to the Codespaces option in the bottom left of the Codespace panel.
+## How to Stop Codespaces?
+#### 1. Navigate to Codespaces Panel
+To stop codespace we just need to navigate to the Codespaces option in the bottom left of the Codespace panel.
 
-    ![stop codespace](../../assets/rdev14.png)
+![stop codespace](../../assets/rdev14.png)
 
-- After clicking on codespaces option we will get a drop down above something like this👇
+#### 2. Open Dropdown Menu
+After clicking on codespaces option we will get a drop down above something like this👇
 
-    ![stop codespace](../../assets/rdev15.png)
+![stop codespace](../../assets/rdev15.png)
 
-- Click on "Stop Current Codespace". It will stop the codespaces you are currently using or running.
+#### 3. Stop Current Codespace
+Click on "Stop Current Codespace". It will stop the codespaces you are currently using or running.
 
-- You will be redirected to a Restart Codespaces page. The page shows a link to restart the codespace you just stopped.
+#### 4. Redirect to Restart Page'
+You will be redirected to a Restart Codespace page. The page shows a link to restart the codespace you just stopped.
 
-    ![stop codespace](../../assets/rdev16.png)
+![stop codespace](../../assets/rdev16.png)
 
 
-#### Idle timeout:
-If you do not interact with the codespace, it will close automatically when it reaches the idle timeout limit. By default, this is 30 minutes, but you can [set a personal timeout](https://docs.github.com/en/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces#setting-your-default-timeout-period) limit in your GitHub settings.
+!!! Note 
+    Idle timeout:
+    If you do not interact with the codespace, it will close automatically when it reaches the idle timeout limit. By default, this is 30 minutes, but you can [set a personal timeout](https://docs.github.com/en/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces#setting-your-default-timeout-period) limit in your GitHub settings.
 
 The code changes and operations we have performed inside the codespace will still be inside the stopped codespace. If your codespace is stopped then you can restart it as shown below.
 
-#### How to Restart Codespaces again?
-
-- Go to [github.com/codespaces](https://github.com/codespaces)
-- Here we can see a list of the codespaces we have created
-  ![stop codespace](../../assets/rdev17.png)
-- To restart it, we can just click on the codespaces we wanted to use and it will start the codespaces again for us.
-- You can also see an active label added to the codespaces we just started
+## How to Restart Codespaces again?
+
+#### 1. Access Codespaces List
+Go to [github.com/codespaces](https://github.com/codespaces)
+#### 2. Restart a Codespace
+Here we can see a list of the codespaces we have created
+ ![stop codespace](../../assets/rdev17.png)
+#### 3. Check Active Status
+To restart it, we can just click on the codespaces we wanted to use and it will start the codespaces again for us.
+#### 4. Manage Codespaces
+You can also see an active label added to the codespaces we just started
  ![stop codespace](../../assets/rdev18.png)
 
 
-#### Managing and Sustaining Codespaces
+## Managing and Sustaining Codespaces
 
-##### Setting a Default Retention Period for Your Codespaces
+### Setting a Default Retention Period for Your Codespaces
 
-**Access Settings:**
+#### 1.Access Settings
 
 - Click your profile photo in the upper-right corner of any GitHub page.
 - Click "Settings."
 
-**Navigate to Codespaces Settings:**
+#### 2.Navigate to Codespaces Settings
 
 - In the sidebar, under "Code, planning, and automation," click "Codespaces."
 
-**Set Retention Period:**
+#### 3.Set Retention Period
 
 - Under "Default retention period," enter the number of days (between 0 and 30) for which you want your codespaces to be retained after they have been stopped.
 Example: Setting it to 30 days.
 ![retain codespace](../../assets/manage_codespace.png)
 
-**Warning:**
-
-- Setting the retention period to 0 days will result in immediate deletion of codespaces when stopped or when they timeout due to inactivity.
-For more details, refer to "Setting your timeout period for GitHub Codespaces."
+!!! Warning
+    Setting the retention period to 0 days will result in immediate deletion of codespaces when stopped or when they timeout due to inactivity.
+    For more details, refer to ["Setting your timeout period for GitHub Codespaces."](https://docs.github.com/en/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces#setting-your-default-timeout-period)
 
-**Save Changes:**
+#### 4.Save Changes
 
 - Click "Save" to apply the new retention period.
 
 
 This allows you to customize how long your codespaces are kept before automatic deletion, balancing convenience and storage management.
 
-**Auto Delete Codespace:**
+### Auto Delete Codespace:
 
 - Go to the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces).
 - Find the codespace you want to exempt from deletion.

diff --git a/docs/container_setup/github_codespace/creating_codespace.md b/docs/container_setup/github_codespace/creating_codespace.md
@@ -1,20 +1,25 @@
 
-1. From the main branch of the [r-dev-env repo](https://github.com/r-devel/r-dev-env/tree/main), click on the 'Open in GitHub Codespaces' button and then click the green 'Create Codespace' button.
+#### 1. Create a Codespace
+
+From the main branch of the [r-dev-env repo](https://github.com/r-devel/r-dev-env/tree/main), click on the 'Open in GitHub Codespaces' button and then click the green 'Create Codespace' button.
 ![create codespace](../../assets/rdev1.png)
 
-    !!! Note
+!!! Note
         You will see the message "Codespace usage for this repository is paid for by ...", with your username. Don't panic!
 
         GitHub Codespaces offers 120 core hours of free usage per month for every GitHub user. So the actual number of free hours is 120 divided by the number of cores you are using to run your codespaces.
         For the r-dev-env codespace we have set the codespace usage to 4 cores which leads to 30hrs of free usage per month. This can be changed according to your preference.
 
-        For more details about codespaces billing, see the [Codespaces Billing Docs](https://github.com/features/codespaces). 
-        You can calculate your GitHub services usage with the [GitHub Services Pricing Calculator](https://github.com/pricing/calculator) and check your usage allowance under "Codespaces" on your [GitHub Billing page](https://github.com/settings/billing).
+-     For more details about codespaces billing, see the [Codespaces Billing Docs](https://github.com/features/codespaces). 
+-      You can calculate your GitHub services usage with the [GitHub Services Pricing Calculator](https://github.com/pricing/calculator) 
+-   Check your usage allowance under "Codespaces" on your [GitHub Billing page](https://github.com/settings/billing).
 
 
-2. The codespace setup screen will then be shown. Starting the container may take a minute or so.
+#### 2. Wait for Container Setup
+The codespace setup screen will then be shown. Starting the container may take a minute or so.
 
-3. You will be taken to a VSCode editor within your browser.
+#### 3. Access VSCode in Browser
+You will be taken to a VSCode editor within your browser.
 ![codespace](../../assets/rdev3.png)
 
 
diff --git a/docs/container_setup/github_codespace/live_share.md b/docs/container_setup/github_codespace/live_share.md
@@ -6,23 +6,27 @@ Live Share is a powerful feature that allows you to collaborate with others in r
 
 ### Start a Live Share Session
 
-1. **Click the "Live Share" button** in the status bar.
-Alternatively you can go to Live Share extension tab and select from the options to share with read/write permission or share with read-only permission.
+#### 1. Click the "Live Share" button in the status bar
+ Alternatively you can go to Live Share extension tab and select from the options to share with read/write permission or share with read-only permission.
 ![alt text](../../assets/live-share.png)
 
-2. **Share the Link**: A sharing link will be generated and copied to the clipboard for sharing with your collaborators. From the pop-up dialog, you can copy the link again or switch the permissions from read/write to read-only (or vice versa).
+#### 2. Share the Link
+ A sharing link will be generated and copied to the clipboard for sharing with your collaborators. From the pop-up dialog, you can copy the link again or switch the permissions from read/write to read-only (or vice versa).
 ![alt text](../../assets/live-share2.png)
 
 ### Join a Live Share Session
 
-1. **Receive the link** from the host. The link will be of the form `https://prod.liveshare.vsengsaas.visualstudio.com/join?[37 alphanumberic characters]`
-2. **Choose how to join the session:**
+#### 1. Receive the link from the host.
+ The link will be of the form `https://prod.liveshare.vsengsaas.visualstudio.com/join?[37 alphanumberic characters]`
 
-    - **Open the link in a web browser**: click the link to open it in your web browser. If you have VS Code installed locally, a pop-up dialog will give you the choice of continuing in the web or opening the session in VS Code. You can join the session anonymously or sign in with your Microsoft or GitHub account.
-    - **Copy the link into VSCode or the R Dev Container Codespace**: From the Live share extension tab, click the "Join" button. If you are using VS Code locally, you can choose to join the session anonymously or sign in with your Microsoft or GitHub account. If you are using the Codespace, you will already be signed in with your GitHub account. A pop-up at the top of the VSCode window will ask for the Live Share session link. Paste the link and click 'Enter'.
+#### 2. Choose how to join the session
+
+- **Open the link in a web browser**: click the link to open it in your web browser. If you have VS Code installed locally, a pop-up dialog will give you the choice of continuing in the web or opening the session in VS Code. You can join the session anonymously or sign in with your Microsoft or GitHub account.
+- **Copy the link into VSCode or the R Dev Container Codespace**: From the Live share extension tab, click the "Join" button. If you are using VS Code locally, you can choose to join the session anonymously or sign in with your Microsoft or GitHub account. If you are using the Codespace, you will already be signed in with your GitHub account. A pop-up at the top of the VSCode window will ask for the Live Share session link. Paste the link and click 'Enter'.
 ![alt text](../../assets/live-share3.png). 
 
-3. **Wait to be accepted by the host**. The host will receive a pop-up message where they can accept your request to join.
+#### 3. Wait for Host Approval
+Wait to be accepted by the host. The host will receive a pop-up message where they can accept your request to join.
 
 ### Collaborate in Real-Time
 

diff --git a/docs/container_setup/gitpod_workspace/live_share.md b/docs/container_setup/gitpod_workspace/live_share.md
@@ -1,11 +1,14 @@
-## Gitpod Live Share Alternative 
-1. Gitpod live share can be started from dashboard itself by clicking on `Share` option on dashboard.
 
-    ![liveshare](../../assets/gitpod5.png)
+#### 1. Start Live Share from Dashboard
+Gitpod live share can be started from dashboard itself by clicking on `Share` option on dashboard.
 
-2. After that whenever you open Gitpod Workspace the live share is enabled and ready to share workspace with others.
+![liveshare](../../assets/gitpod5.png)
 
+#### 2. Live Share Enabled in Workspace 
+After that whenever you open Gitpod Workspace the live share is enabled and ready to share workspace with others.
 
-    ![liveshare](../../assets/gitpod6.png)
 
-    !!! Note: The live share will be enabled even if you close the workspace.
+![liveshare](../../assets/gitpod6.png)
+
+!!! Note
+    The live share will be enabled even if you close the workspace.
diff --git a/docs/container_setup/gitpod_workspace/workspacestart.md b/docs/container_setup/gitpod_workspace/workspacestart.md
@@ -1,21 +1,22 @@
 
-### Starting a Gitpod Workspace
+# Starting a Gitpod Workspace
 
-1. **Log In:**
+#### 1. Log In to Gitpod
 Go to the [Gitpod login page](https://gitpod.io/login/) and sign in with your GitHub, GitLab, or Bitbucket account. This allows Gitpod to create workspaces from your repositories.
 
-2. **Create a workspace using the R Dev Container repo:**
-Click the Gitpod badge below to open the Gitpod workspace creation dialog with the relevant options pre-filled:
+#### 2. Create a workspace 
+To create a workspace using the R Dev Container repo,
+click the Gitpod badge below to open the Gitpod workspace creation dialog with the relevant options pre-filled:
 
-    <figure markdown="span">
-    [![Open in Gitpod](https://img.shields.io/badge/Gitpod-Open%20in%20Gitpod-blue?logo=gitpod&style=for-the-badge)](https://gitpod.io/github.com/r-devel/r-dev-env/tree/main){:target="_blank"}
-    </figure>
+<figure markdown="span">
+[![Open in Gitpod](https://img.shields.io/badge/Gitpod-Open%20in%20Gitpod-blue?logo=gitpod&style=for-the-badge)](https://gitpod.io/github.com/r-devel/r-dev-env/tree/main){:target="_blank"}
+</figure>
 
-    <figure markdown="span">
-    ![start gitpod workspace](../../assets/gitpod1.png){width="70%"} 
-    </figure>
+<figure markdown="span">
+![start gitpod workspace](../../assets/gitpod1.png){width="70%"} 
+</figure>
 
-    Click the "Continue" button in the Gitpod dialog to create a workspace. It will take approximately 15-20 minutes to create the workspace for the first time. The environment will be cached for faster startup in the future.
+Click the "Continue" button in the Gitpod dialog to create a workspace. It will take approximately 15-20 minutes to create the workspace for the first time. The environment will be cached for faster startup in the future.
 
-    !!! Note
-        Changing the resource option from Standard to Large will reduce the free monthly Gitpod usage, which is 50 hours per month of Standard workspace usage. See the [billing](https://www.gitpod.io/docs/configure/billing) docs for more information.
+!!! Note
+    Changing the resource option from Standard to Large will reduce the free monthly Gitpod usage, which is 50 hours per month of Standard workspace usage. See the [billing](https://www.gitpod.io/docs/configure/billing) docs for more information.
diff --git a/docs/container_setup/gitpod_workspace/workspacestop_and_restart.md b/docs/container_setup/gitpod_workspace/workspacestop_and_restart.md
@@ -1,30 +1,30 @@
-### Stopping a Gitpod Workspace
+## Stopping a Gitpod Workspace
 
-1. **Locate the Gitpod Command Palette Button:**
+#### 1. Locate the Gitpod Command Palette Button
 To stop the current workspace, look for the orange Gitpod command palette button in the bottom left corner of the workspace.
 
-    ![stop gitpod workspace](../../assets/gitpod2.png)   
-2. **Open the Command Palette and Stop the Workspace:**
+![stop gitpod workspace](../../assets/gitpod2.png)   
+#### 2. Open the Command Palette and Stop the Workspace:
 After clicking on the Gitpod command palette button, a pop-up will appear from the top of the screen. Select the Gitpod: Stop Workspace option to stop the current workspace.
 
-    ![stop gitpod workspace](../../assets/gitpod3.png)
+![stop gitpod workspace](../../assets/gitpod3.png)
 
 
-    !!! Note
-        Stopping a workspace will save its state, so you can resume later without losing your progress.
+!!! Note
+    Stopping a workspace will save its state, so you can resume later without losing your progress.
 
 
-### Restarting a Gitpod Workspace
+## Restarting a Gitpod Workspace
 
-1. **Open Gitpod Dashboard:**
+#### 1. Open Gitpod Dashboard
 Once you're in the Gitpod dashboard, navigate to the "Workspaces" section. In the "Workspaces" section, you will see a list of your current and past workspaces. Locate the workspace you want to restart. Stopped workspaces will have an indicator showing they are not running.
 
-    ![restart gitpod workspace](../../assets/gitpod4.png)   
-2. **Restart the Workspace:**
+![restart gitpod workspace](../../assets/gitpod4.png)   
+#### 2. Restart the Workspace
 To restart a workspace, click on the workspace in the list you want to restart. This will launch the workspace, restoring it to the state it was in when it was last stopped.
 
 
-### Managing and Sustaining Codespaces
+## Managing and Sustaining Codespaces
 
 **Gitpod Workspace Pinning**
 

diff --git a/docs/container_setup/index.md b/docs/container_setup/index.md
@@ -2,10 +2,10 @@
 
 You can run the R Dev Container in one of the ways:
 
-- **GitHub Codespaces**: Offers 60 hours per month of free usage for 2-core set-ups and 15GB of free storage. The R Dev Container codespace is set up to use 4 cores by default, which gives users 30 hours per month of free usage. Check out the [Codespace pricing docs](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-github-codespaces-pricing) for more information.
+- **[GitHub Codespace](github_codespace/creating_codespace.md)**: Offers 60 hours per month of free usage for 2-core set-ups and 15GB of free storage. The R Dev Container codespace is set up to use 4 cores by default, which gives users 30 hours per month of free usage. Check out the [Codespace pricing docs](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-github-codespaces-pricing) for more information.
 
-- **Gitpod Workspaces**: Offers 50 hours per month of free usage. Check out the [Gitpod pricing docs](https://www.gitpod.io/pricing) for more information.
+- **[Gitpod Workspace](gitpod_workspace/workspacestart.md)**: Offers 50 hours per month of free usage. Check out the [Gitpod pricing docs](https://www.gitpod.io/pricing) for more information.
 
-- **Local Setup**: Currently recommended for Linux users only.
+- **[Local Setup](local_setup)**: Currently recommended for Linux users only.
 
 Explore the sub-sections for detailed instructions on setting up and using the container for each option.